2025/10/01 - AWS Clean Rooms Service - 11 updated api methods
Changes This release introduces data access budgets to control how many times a table can be used for queries and jobs in a collaboration.
{'schemas': {'resourceArn': 'string'}}
Retrieves multiple schemas by their identifiers.
See also: AWS API Documentation
Request Syntax
client.batch_get_schema(
collaborationIdentifier='string',
names=[
'string',
]
)
string
[REQUIRED]
A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
list
[REQUIRED]
The names for the schema objects to retrieve.
(string) --
dict
Response Syntax
{
'schemas': [
{
'columns': [
{
'name': 'string',
'type': 'string'
},
],
'partitionKeys': [
{
'name': 'string',
'type': 'string'
},
],
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
],
'creatorAccountId': 'string',
'name': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'type': 'TABLE'|'ID_MAPPING_TABLE',
'schemaStatusDetails': [
{
'status': 'READY'|'NOT_READY',
'reasons': [
{
'code': 'ANALYSIS_RULE_MISSING'|'ANALYSIS_TEMPLATES_NOT_CONFIGURED'|'ANALYSIS_PROVIDERS_NOT_CONFIGURED'|'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED'|'COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED'|'ADDITIONAL_ANALYSES_NOT_CONFIGURED'|'RESULT_RECEIVERS_NOT_CONFIGURED'|'ADDITIONAL_ANALYSES_NOT_ALLOWED'|'RESULT_RECEIVERS_NOT_ALLOWED'|'ANALYSIS_RULE_TYPES_NOT_COMPATIBLE',
'message': 'string'
},
],
'analysisRuleType': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'configurations': [
'DIFFERENTIAL_PRIVACY',
],
'analysisType': 'DIRECT_ANALYSIS'|'ADDITIONAL_ANALYSIS'
},
],
'resourceArn': 'string',
'schemaTypeProperties': {
'idMappingTable': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
}
}
},
],
'errors': [
{
'name': 'string',
'code': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
schemas (list) --
The retrieved list of schemas.
(dict) --
A schema is a relation within a collaboration.
columns (list) --
The columns for the relation that this schema represents.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
partitionKeys (list) --
The partition keys for the dataset underlying this schema.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
analysisRuleTypes (list) --
The analysis rule types that are associated with the schema. Currently, only one entry is present.
(string) --
analysisMethod (string) --
The analysis method for the schema.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
selectedAnalysisMethods (list) --
The selected analysis methods for the schema.
(string) --
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
name (string) --
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
description (string) --
A description for the schema.
createTime (datetime) --
The time at which the schema was created.
updateTime (datetime) --
The most recent time at which the schema was updated.
type (string) --
The type of schema.
schemaStatusDetails (list) --
Details about the status of the schema. Currently, only one entry is present.
(dict) --
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
status (string) --
The status of the schema, indicating if it is ready to query.
reasons (list) --
The reasons why the schema status is set to its current state.
(dict) --
A reason why the schema status is set to its current value.
code (string) --
The schema status reason code.
message (string) --
An explanation of the schema status reason code.
analysisRuleType (string) --
The analysis rule type for which the schema status has been evaluated.
configurations (list) --
The configuration details of the schema analysis rule for the given type.
(string) --
analysisType (string) --
The type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
resourceArn (string) --
The Amazon Resource Name (ARN) of the schema resource.
schemaTypeProperties (dict) --
The schema type properties.
idMappingTable (dict) --
The ID mapping table for the schema type properties.
idMappingTableInputSource (list) --
Defines which ID namespace associations are used to create the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
errors (list) --
Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
(dict) --
An error describing why a schema could not be fetched.
name (string) --
An error name for the error.
code (string) --
An error code for the error.
message (string) --
An error message for the error.
{'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY | '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| LIFETIME'}],
'resourceArn': 'string'}},
'privacyBudgetType': {'ACCESS_BUDGET'}}
Response {'privacyBudgetTemplate': {'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME'}],
'resourceArn': 'string'}},
'privacyBudgetType': {'ACCESS_BUDGET'}}}
Creates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.
See also: AWS API Documentation
Request Syntax
client.create_privacy_budget_template(
membershipIdentifier='string',
autoRefresh='CALENDAR_MONTH'|'NONE',
privacyBudgetType='DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
parameters={
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'resourceArn': 'string'
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
string
How often the privacy budget refreshes.
string
[REQUIRED]
Specifies the type of the privacy budget template.
dict
[REQUIRED]
Specifies your parameters for the privacy budget template.
differentialPrivacy (dict) --
An object that specifies the epsilon and noise parameters.
epsilon (integer) -- [REQUIRED]
The epsilon value that you want to use.
usersNoisePerQuery (integer) -- [REQUIRED]
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
Access budget configuration for the privacy budget template input, enabling integration with access budget functionality.
budgetParameters (list) -- [REQUIRED]
An array of budget parameters that define the access budget configuration for the privacy template.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) -- [REQUIRED]
The type of budget parameter being configured.
budget (integer) -- [REQUIRED]
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
resourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.
dict
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
(string) --
(string) --
dict
Response Syntax
{
'privacyBudgetTemplate': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'autoRefresh': 'CALENDAR_MONTH'|'NONE',
'parameters': {
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'resourceArn': 'string'
}
}
}
}
Response Structure
(dict) --
privacyBudgetTemplate (dict) --
A summary of the elements in the privacy budget template.
id (string) --
The unique identifier of the privacy budget template.
arn (string) --
The ARN of the privacy budget template.
membershipId (string) --
The identifier for a membership resource.
membershipArn (string) --
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
collaborationId (string) --
The unique ID of the collaboration that contains this privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that contains this privacy budget template.
createTime (datetime) --
The time at which the privacy budget template was created.
updateTime (datetime) --
The most recent time at which the privacy budget template was updated.
privacyBudgetType (string) --
Specifies the type of the privacy budget template.
autoRefresh (string) --
How often the privacy budget refreshes.
parameters (dict) --
Specifies the epsilon and noise parameters for the privacy budget template.
differentialPrivacy (dict) --
The epsilon and noise parameters.
epsilon (integer) --
The epsilon value that you specified.
usersNoisePerQuery (integer) --
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
Access budget configuration returned from the privacy budget template, containing the configured access budget settings.
budgetParameters (list) --
An array of budget parameters returned from the access budget configuration.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) --
The type of budget parameter being configured.
budget (integer) --
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.
{'collaborationPrivacyBudgetTemplate': {'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME'}],
'resourceArn': 'string'}},
'privacyBudgetType': {'ACCESS_BUDGET'}}}
Returns details about a specified privacy budget template.
See also: AWS API Documentation
Request Syntax
client.get_collaboration_privacy_budget_template(
collaborationIdentifier='string',
privacyBudgetTemplateIdentifier='string'
)
string
[REQUIRED]
A unique identifier for one of your collaborations.
string
[REQUIRED]
A unique identifier for one of your privacy budget templates.
dict
Response Syntax
{
'collaborationPrivacyBudgetTemplate': {
'id': 'string',
'arn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'creatorAccountId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'autoRefresh': 'CALENDAR_MONTH'|'NONE',
'parameters': {
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'resourceArn': 'string'
}
}
}
}
Response Structure
(dict) --
collaborationPrivacyBudgetTemplate (dict) --
Returns the details of the privacy budget template that you requested.
id (string) --
The unique identifier of the collaboration privacy budget template.
arn (string) --
The ARN of the collaboration privacy budget template.
collaborationId (string) --
The unique identifier of the collaboration that includes this collaboration privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that includes this collaboration privacy budget template.
creatorAccountId (string) --
The unique identifier of the account that created this collaboration privacy budget template.
createTime (datetime) --
The time at which the collaboration privacy budget template was created.
updateTime (datetime) --
The most recent time at which the collaboration privacy budget template was updated.
privacyBudgetType (string) --
The type of privacy budget template.
autoRefresh (string) --
How often the privacy budget refreshes.
parameters (dict) --
Specifies the epsilon and noise parameters for the privacy budget template.
differentialPrivacy (dict) --
The epsilon and noise parameters.
epsilon (integer) --
The epsilon value that you specified.
usersNoisePerQuery (integer) --
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
Access budget configuration returned from the privacy budget template, containing the configured access budget settings.
budgetParameters (list) --
An array of budget parameters returned from the access budget configuration.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) --
The type of budget parameter being configured.
budget (integer) --
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.
{'privacyBudgetTemplate': {'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME'}],
'resourceArn': 'string'}},
'privacyBudgetType': {'ACCESS_BUDGET'}}}
Returns details for a specified privacy budget template.
See also: AWS API Documentation
Request Syntax
client.get_privacy_budget_template(
membershipIdentifier='string',
privacyBudgetTemplateIdentifier='string'
)
string
[REQUIRED]
A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
string
[REQUIRED]
A unique identifier for your privacy budget template.
dict
Response Syntax
{
'privacyBudgetTemplate': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'autoRefresh': 'CALENDAR_MONTH'|'NONE',
'parameters': {
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'resourceArn': 'string'
}
}
}
}
Response Structure
(dict) --
privacyBudgetTemplate (dict) --
Returns the details of the privacy budget template that you requested.
id (string) --
The unique identifier of the privacy budget template.
arn (string) --
The ARN of the privacy budget template.
membershipId (string) --
The identifier for a membership resource.
membershipArn (string) --
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
collaborationId (string) --
The unique ID of the collaboration that contains this privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that contains this privacy budget template.
createTime (datetime) --
The time at which the privacy budget template was created.
updateTime (datetime) --
The most recent time at which the privacy budget template was updated.
privacyBudgetType (string) --
Specifies the type of the privacy budget template.
autoRefresh (string) --
How often the privacy budget refreshes.
parameters (dict) --
Specifies the epsilon and noise parameters for the privacy budget template.
differentialPrivacy (dict) --
The epsilon and noise parameters.
epsilon (integer) --
The epsilon value that you specified.
usersNoisePerQuery (integer) --
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
Access budget configuration returned from the privacy budget template, containing the configured access budget settings.
budgetParameters (list) --
An array of budget parameters returned from the access budget configuration.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) --
The type of budget parameter being configured.
budget (integer) --
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.
{'schema': {'resourceArn': 'string'}}
Retrieves the schema for a relation within a collaboration.
See also: AWS API Documentation
Request Syntax
client.get_schema(
collaborationIdentifier='string',
name='string'
)
string
[REQUIRED]
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
string
[REQUIRED]
The name of the relation to retrieve the schema for.
dict
Response Syntax
{
'schema': {
'columns': [
{
'name': 'string',
'type': 'string'
},
],
'partitionKeys': [
{
'name': 'string',
'type': 'string'
},
],
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
],
'creatorAccountId': 'string',
'name': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'description': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'type': 'TABLE'|'ID_MAPPING_TABLE',
'schemaStatusDetails': [
{
'status': 'READY'|'NOT_READY',
'reasons': [
{
'code': 'ANALYSIS_RULE_MISSING'|'ANALYSIS_TEMPLATES_NOT_CONFIGURED'|'ANALYSIS_PROVIDERS_NOT_CONFIGURED'|'DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED'|'ID_MAPPING_TABLE_NOT_POPULATED'|'COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED'|'ADDITIONAL_ANALYSES_NOT_CONFIGURED'|'RESULT_RECEIVERS_NOT_CONFIGURED'|'ADDITIONAL_ANALYSES_NOT_ALLOWED'|'RESULT_RECEIVERS_NOT_ALLOWED'|'ANALYSIS_RULE_TYPES_NOT_COMPATIBLE',
'message': 'string'
},
],
'analysisRuleType': 'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
'configurations': [
'DIFFERENTIAL_PRIVACY',
],
'analysisType': 'DIRECT_ANALYSIS'|'ADDITIONAL_ANALYSIS'
},
],
'resourceArn': 'string',
'schemaTypeProperties': {
'idMappingTable': {
'idMappingTableInputSource': [
{
'idNamespaceAssociationId': 'string',
'type': 'SOURCE'|'TARGET'
},
]
}
}
}
}
Response Structure
(dict) --
schema (dict) --
The entire schema object.
columns (list) --
The columns for the relation that this schema represents.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
partitionKeys (list) --
The partition keys for the dataset underlying this schema.
(dict) --
A column within a schema relation, derived from the underlying table.
name (string) --
The name of the column.
type (string) --
The type of the column.
analysisRuleTypes (list) --
The analysis rule types that are associated with the schema. Currently, only one entry is present.
(string) --
analysisMethod (string) --
The analysis method for the schema.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
selectedAnalysisMethods (list) --
The selected analysis methods for the schema.
(string) --
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
name (string) --
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.
description (string) --
A description for the schema.
createTime (datetime) --
The time at which the schema was created.
updateTime (datetime) --
The most recent time at which the schema was updated.
type (string) --
The type of schema.
schemaStatusDetails (list) --
Details about the status of the schema. Currently, only one entry is present.
(dict) --
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
status (string) --
The status of the schema, indicating if it is ready to query.
reasons (list) --
The reasons why the schema status is set to its current state.
(dict) --
A reason why the schema status is set to its current value.
code (string) --
The schema status reason code.
message (string) --
An explanation of the schema status reason code.
analysisRuleType (string) --
The analysis rule type for which the schema status has been evaluated.
configurations (list) --
The configuration details of the schema analysis rule for the given type.
(string) --
analysisType (string) --
The type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
resourceArn (string) --
The Amazon Resource Name (ARN) of the schema resource.
schemaTypeProperties (dict) --
The schema type properties.
idMappingTable (dict) --
The ID mapping table for the schema type properties.
idMappingTableInputSource (list) --
Defines which ID namespace associations are used to create the ID mapping table.
(dict) --
The input source of the ID mapping table.
idNamespaceAssociationId (string) --
The unique identifier of the ID namespace association.
type (string) --
The type of the input source of the ID mapping table.
{'collaborationPrivacyBudgetTemplateSummaries': {'privacyBudgetType': {'ACCESS_BUDGET'}}}
Returns an array that summarizes each privacy budget template in a specified collaboration.
See also: AWS API Documentation
Request Syntax
client.list_collaboration_privacy_budget_templates(
collaborationIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for one of your collaborations.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'nextToken': 'string',
'collaborationPrivacyBudgetTemplateSummaries': [
{
'id': 'string',
'arn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'creatorAccountId': 'string',
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
collaborationPrivacyBudgetTemplateSummaries (list) --
An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.
(dict) --
A summary of the collaboration's privacy budget template. This summary includes information about who created the privacy budget template and what collaborations it belongs to.
id (string) --
The unique identifier of the collaboration privacy budget template.
arn (string) --
The ARN of the collaboration privacy budget template.
collaborationId (string) --
The unique identifier of the collaboration that contains this collaboration privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that contains this collaboration privacy budget template.
creatorAccountId (string) --
The unique identifier of the account that created this collaboration privacy budget template.
privacyBudgetType (string) --
The type of the privacy budget template.
createTime (datetime) --
The time at which the collaboration privacy budget template was created.
updateTime (datetime) --
The most recent time at which the collaboration privacy budget template was updated.
{'accessBudgetResourceArn': 'string', 'privacyBudgetType': {'ACCESS_BUDGET'}}
Response {'collaborationPrivacyBudgetSummaries': {'budget': {'accessBudget': {'aggregateRemainingBudget': 'integer',
'details': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'budgetType': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME',
'endTime': 'timestamp',
'remainingBudget': 'integer',
'startTime': 'timestamp'}],
'resourceArn': 'string'}},
'type': {'ACCESS_BUDGET'}}}
Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
See also: AWS API Documentation
Request Syntax
client.list_collaboration_privacy_budgets(
collaborationIdentifier='string',
privacyBudgetType='DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
maxResults=123,
nextToken='string',
accessBudgetResourceArn='string'
)
string
[REQUIRED]
A unique identifier for one of your collaborations.
string
[REQUIRED]
Specifies the type of the privacy budget.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
string
The pagination token that's used to fetch the next set of results.
string
The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.
dict
Response Syntax
{
'collaborationPrivacyBudgetSummaries': [
{
'id': 'string',
'privacyBudgetTemplateId': 'string',
'privacyBudgetTemplateArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'creatorAccountId': 'string',
'type': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'budget': {
'differentialPrivacy': {
'aggregations': [
{
'type': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'maxCount': 123,
'remainingCount': 123
},
],
'epsilon': 123
},
'accessBudget': {
'resourceArn': 'string',
'details': [
{
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'remainingBudget': 123,
'budget': 123,
'budgetType': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'aggregateRemainingBudget': 123
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
collaborationPrivacyBudgetSummaries (list) --
Summaries of the collaboration privacy budgets.
(dict) --
A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.
id (string) --
The unique identifier of the collaboration privacy budget.
privacyBudgetTemplateId (string) --
The unique identifier of the collaboration privacy budget template.
privacyBudgetTemplateArn (string) --
The ARN of the collaboration privacy budget template.
collaborationId (string) --
The unique identifier of the collaboration that includes this privacy budget.
collaborationArn (string) --
The ARN of the collaboration that includes this privacy budget.
creatorAccountId (string) --
The unique identifier of the account that created this privacy budget.
type (string) --
The type of privacy budget template.
createTime (datetime) --
The time at which the privacy budget was created.
updateTime (datetime) --
The most recent time at which the privacy budget was updated.
budget (dict) --
The includes epsilon provided and utility in terms of aggregations.
differentialPrivacy (dict) --
An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
aggregations (list) --
This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.
(dict) --
Information about the total number of aggregations, as well as the remaining aggregations.
type (string) --
The different types of aggregation functions that you can perform.
maxCount (integer) --
The maximum number of aggregation functions that you can perform with the given privacy budget.
remainingCount (integer) --
The remaining number of aggregation functions that can be run with the available privacy budget.
epsilon (integer) --
The epsilon value that you configured.
accessBudget (dict) --
Access budget information associated with this privacy budget.
resourceArn (string) --
The Amazon Resource Name (ARN) of the access budget resource.
details (list) --
Detailed budget information including time bounds, remaining budget, and refresh settings.
(dict) --
Detailed information about an access budget including time bounds, budget allocation, and configuration settings.
startTime (datetime) --
The start time for the access budget period.
endTime (datetime) --
The end time for the access budget period.
remainingBudget (integer) --
The remaining budget amount available for use within this access budget.
budget (integer) --
The total budget allocation amount for this access budget.
budgetType (string) --
Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:
CALENDAR_DAY - Limit table usage per day.
CALENDAR_WEEK - Limit table usage per week.
CALENDAR_MONTH - Limit table usage per month.
LIFETIME - Limit total table usage for the collaboration duration.
autoRefresh (string) --
Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:
ENABLED - The budget refreshes automatically at the start of each period.
DISABLED - The budget must be refreshed manually.
NULL - The value is null when budgetType is set to LIFETIME.
aggregateRemainingBudget (integer) --
The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see remainingBudget.
nextToken (string) --
The pagination token that's used to fetch the next set of results.
{'privacyBudgetTemplateSummaries': {'privacyBudgetType': {'ACCESS_BUDGET'}}}
Returns detailed information about the privacy budget templates in a specified membership.
See also: AWS API Documentation
Request Syntax
client.list_privacy_budget_templates(
membershipIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'nextToken': 'string',
'privacyBudgetTemplateSummaries': [
{
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
privacyBudgetTemplateSummaries (list) --
An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.
(dict) --
A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.
id (string) --
The unique identifier of the privacy budget template.
arn (string) --
The ARN of the privacy budget template.
membershipId (string) --
The identifier for a membership resource.
membershipArn (string) --
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
collaborationId (string) --
The unique ID of the collaboration that contains this privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that contains this privacy budget template.
privacyBudgetType (string) --
The type of the privacy budget template.
createTime (datetime) --
The time at which the privacy budget template was created.
updateTime (datetime) --
The most recent time at which the privacy budget template was updated.
{'accessBudgetResourceArn': 'string', 'privacyBudgetType': {'ACCESS_BUDGET'}}
Response {'privacyBudgetSummaries': {'budget': {'accessBudget': {'aggregateRemainingBudget': 'integer',
'details': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'budgetType': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME',
'endTime': 'timestamp',
'remainingBudget': 'integer',
'startTime': 'timestamp'}],
'resourceArn': 'string'}},
'type': {'ACCESS_BUDGET'}}}
Returns detailed information about the privacy budgets in a specified membership.
See also: AWS API Documentation
Request Syntax
client.list_privacy_budgets(
membershipIdentifier='string',
privacyBudgetType='DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
nextToken='string',
maxResults=123,
accessBudgetResourceArn='string'
)
string
[REQUIRED]
A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
string
[REQUIRED]
The privacy budget type.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
string
The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.
dict
Response Syntax
{
'privacyBudgetSummaries': [
{
'id': 'string',
'privacyBudgetTemplateId': 'string',
'privacyBudgetTemplateArn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'type': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'budget': {
'differentialPrivacy': {
'aggregations': [
{
'type': 'AVG'|'COUNT'|'COUNT_DISTINCT'|'SUM'|'STDDEV',
'maxCount': 123,
'remainingCount': 123
},
],
'epsilon': 123
},
'accessBudget': {
'resourceArn': 'string',
'details': [
{
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'remainingBudget': 123,
'budget': 123,
'budgetType': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'aggregateRemainingBudget': 123
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
privacyBudgetSummaries (list) --
An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.
(dict) --
An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.
id (string) --
The unique identifier of the privacy budget.
privacyBudgetTemplateId (string) --
The unique identifier of the privacy budget template.
privacyBudgetTemplateArn (string) --
The ARN of the privacy budget template.
membershipId (string) --
The identifier for a membership resource.
membershipArn (string) --
The Amazon Resource Name (ARN) of the member who created the privacy budget summary.
collaborationId (string) --
The unique identifier of the collaboration that contains this privacy budget.
collaborationArn (string) --
The ARN of the collaboration that contains this privacy budget.
type (string) --
Specifies the type of the privacy budget.
createTime (datetime) --
The time at which the privacy budget was created.
updateTime (datetime) --
The most recent time at which the privacy budget was updated.
budget (dict) --
The provided privacy budget.
differentialPrivacy (dict) --
An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
aggregations (list) --
This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.
(dict) --
Information about the total number of aggregations, as well as the remaining aggregations.
type (string) --
The different types of aggregation functions that you can perform.
maxCount (integer) --
The maximum number of aggregation functions that you can perform with the given privacy budget.
remainingCount (integer) --
The remaining number of aggregation functions that can be run with the available privacy budget.
epsilon (integer) --
The epsilon value that you configured.
accessBudget (dict) --
Access budget information associated with this privacy budget.
resourceArn (string) --
The Amazon Resource Name (ARN) of the access budget resource.
details (list) --
Detailed budget information including time bounds, remaining budget, and refresh settings.
(dict) --
Detailed information about an access budget including time bounds, budget allocation, and configuration settings.
startTime (datetime) --
The start time for the access budget period.
endTime (datetime) --
The end time for the access budget period.
remainingBudget (integer) --
The remaining budget amount available for use within this access budget.
budget (integer) --
The total budget allocation amount for this access budget.
budgetType (string) --
Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:
CALENDAR_DAY - Limit table usage per day.
CALENDAR_WEEK - Limit table usage per week.
CALENDAR_MONTH - Limit table usage per month.
LIFETIME - Limit total table usage for the collaboration duration.
autoRefresh (string) --
Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:
ENABLED - The budget refreshes automatically at the start of each period.
DISABLED - The budget must be refreshed manually.
NULL - The value is null when budgetType is set to LIFETIME.
aggregateRemainingBudget (integer) --
The total remaining budget across all budget parameters, showing the lower value between the per-period budget and lifetime budget for this access budget. For individual parameter budgets, see remainingBudget.
nextToken (string) --
The pagination token that's used to fetch the next set of results.
{'schemaSummaries': {'resourceArn': 'string'}}
Lists the schemas for relations within a collaboration.
See also: AWS API Documentation
Request Syntax
client.list_schemas(
collaborationIdentifier='string',
schemaType='TABLE'|'ID_MAPPING_TABLE',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
string
If present, filter schemas by schema type.
string
The pagination token that's used to fetch the next set of results.
integer
The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
dict
Response Syntax
{
'schemaSummaries': [
{
'name': 'string',
'type': 'TABLE'|'ID_MAPPING_TABLE',
'creatorAccountId': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'collaborationId': 'string',
'collaborationArn': 'string',
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM'|'ID_MAPPING_TABLE',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'resourceArn': 'string',
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
schemaSummaries (list) --
The retrieved list of schemas.
(dict) --
The schema summary for the objects listed by the request.
name (string) --
The name for the schema object.
type (string) --
The type of schema object.
creatorAccountId (string) --
The unique account ID for the Amazon Web Services account that owns the schema.
createTime (datetime) --
The time the schema object was created.
updateTime (datetime) --
The time the schema object was last updated.
collaborationId (string) --
The unique ID for the collaboration that the schema belongs to.
collaborationArn (string) --
The unique ARN for the collaboration that the schema belongs to.
analysisRuleTypes (list) --
The types of analysis rules that are associated with this schema object.
(string) --
analysisMethod (string) --
The analysis method for the associated schema.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
resourceArn (string) --
The Amazon Resource Name (ARN) of the schema summary resource.
selectedAnalysisMethods (list) --
The selected analysis methods for the schema.
(string) --
nextToken (string) --
The pagination token that's used to fetch the next set of results.
{'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY | '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| LIFETIME'}]}},
'privacyBudgetType': {'ACCESS_BUDGET'}}
Response {'privacyBudgetTemplate': {'parameters': {'accessBudget': {'budgetParameters': [{'autoRefresh': 'ENABLED '
'| '
'DISABLED',
'budget': 'integer',
'type': 'CALENDAR_DAY '
'| '
'CALENDAR_MONTH '
'| '
'CALENDAR_WEEK '
'| '
'LIFETIME'}],
'resourceArn': 'string'}},
'privacyBudgetType': {'ACCESS_BUDGET'}}}
Updates the privacy budget template for the specified collaboration.
See also: AWS API Documentation
Request Syntax
client.update_privacy_budget_template(
membershipIdentifier='string',
privacyBudgetTemplateIdentifier='string',
privacyBudgetType='DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
parameters={
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
]
}
}
)
string
[REQUIRED]
A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.
string
[REQUIRED]
A unique identifier for your privacy budget template that you want to update.
string
[REQUIRED]
Specifies the type of the privacy budget template.
dict
Specifies the epsilon and noise parameters for the privacy budget template.
differentialPrivacy (dict) --
An object that specifies the new values for the epsilon and noise parameters.
epsilon (integer) --
The updated epsilon value that you want to use.
usersNoisePerQuery (integer) --
The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
The new access budget configuration that completely replaces the existing access budget settings in the privacy budget template.
budgetParameters (list) -- [REQUIRED]
Updated array of budget parameters for the access budget configuration.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) -- [REQUIRED]
The type of budget parameter being configured.
budget (integer) -- [REQUIRED]
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
dict
Response Syntax
{
'privacyBudgetTemplate': {
'id': 'string',
'arn': 'string',
'membershipId': 'string',
'membershipArn': 'string',
'collaborationId': 'string',
'collaborationArn': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'privacyBudgetType': 'DIFFERENTIAL_PRIVACY'|'ACCESS_BUDGET',
'autoRefresh': 'CALENDAR_MONTH'|'NONE',
'parameters': {
'differentialPrivacy': {
'epsilon': 123,
'usersNoisePerQuery': 123
},
'accessBudget': {
'budgetParameters': [
{
'type': 'CALENDAR_DAY'|'CALENDAR_MONTH'|'CALENDAR_WEEK'|'LIFETIME',
'budget': 123,
'autoRefresh': 'ENABLED'|'DISABLED'
},
],
'resourceArn': 'string'
}
}
}
}
Response Structure
(dict) --
privacyBudgetTemplate (dict) --
Summary of the privacy budget template.
id (string) --
The unique identifier of the privacy budget template.
arn (string) --
The ARN of the privacy budget template.
membershipId (string) --
The identifier for a membership resource.
membershipArn (string) --
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
collaborationId (string) --
The unique ID of the collaboration that contains this privacy budget template.
collaborationArn (string) --
The ARN of the collaboration that contains this privacy budget template.
createTime (datetime) --
The time at which the privacy budget template was created.
updateTime (datetime) --
The most recent time at which the privacy budget template was updated.
privacyBudgetType (string) --
Specifies the type of the privacy budget template.
autoRefresh (string) --
How often the privacy budget refreshes.
parameters (dict) --
Specifies the epsilon and noise parameters for the privacy budget template.
differentialPrivacy (dict) --
The epsilon and noise parameters.
epsilon (integer) --
The epsilon value that you specified.
usersNoisePerQuery (integer) --
Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
accessBudget (dict) --
Access budget configuration returned from the privacy budget template, containing the configured access budget settings.
budgetParameters (list) --
An array of budget parameters returned from the access budget configuration.
(dict) --
Individual budget parameter configuration that defines specific budget allocation settings for access budgets.
type (string) --
The type of budget parameter being configured.
budget (integer) --
The budget allocation amount for this specific parameter.
autoRefresh (string) --
Whether this individual budget parameter automatically refreshes when the budget period resets.
resourceArn (string) --
The Amazon Resource Name (ARN) of the resource associated with this privacy budget template.