PrivacyBudgetTemplate - AWS Clean Rooms

PrivacyBudgetTemplate

An object that defines the privacy budget template.

Contents

arn

The ARN of the privacy budget template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:privacybudgettemplate/[\d\w-]+

Required: Yes

autoRefresh

How often the privacy budget refreshes.

Important

If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

Type: String

Valid Values: CALENDAR_MONTH | NONE

Required: Yes

collaborationArn

The ARN of the collaboration that contains this privacy budget template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+

Required: Yes

collaborationId

The unique ID of the collaboration that contains this privacy budget template.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

createTime

The time at which the privacy budget template was created.

Type: Timestamp

Required: Yes

id

The unique identifier of the privacy budget template.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

membershipArn

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+

Required: Yes

membershipId

The identifier for a membership resource.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

parameters

Specifies the epsilon and noise parameters for the privacy budget template.

Type: PrivacyBudgetTemplateParametersOutput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

privacyBudgetType

Specifies the type of the privacy budget template.

Type: String

Valid Values: DIFFERENTIAL_PRIVACY

Required: Yes

updateTime

The most recent time at which the privacy budget template was updated.

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: