2025/10/03 - AWS Clean Rooms Service - 6 updated api methods
Changes Added support for reading data sources across regions, and results delivery to allowedlisted regions.
{'allowedResultRegions': ['us-west-1 | us-west-2 | us-east-1 | us-east-2 | '
'af-south-1 | ap-east-1 | ap-east-2 | ap-south-2 | '
'ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | ap-southeast-7 | '
'ap-south-1 | ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | ca-west-1 | '
'eu-south-1 | eu-west-3 | eu-south-2 | eu-central-2 '
'| eu-central-1 | eu-north-1 | eu-west-1 | eu-west-2 '
'| me-south-1 | me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1']}
Response {'collaboration': {'allowedResultRegions': ['us-west-1 | us-west-2 | us-east-1 '
'| us-east-2 | af-south-1 | '
'ap-east-1 | ap-east-2 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | '
'eu-west-3 | eu-south-2 | '
'eu-central-2 | eu-central-1 | '
'eu-north-1 | eu-west-1 | '
'eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1']}}
Creates a new collaboration.
See also: AWS API Documentation
Request Syntax
client.create_collaboration(
members=[
{
'accountId': 'string',
'memberAbilities': [
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
'mlMemberAbilities': {
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
'displayName': 'string',
'paymentConfiguration': {
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
}
},
],
name='string',
description='string',
creatorMemberAbilities=[
'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
],
creatorMLMemberAbilities={
'customMLMemberAbilities': [
'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
]
},
creatorDisplayName='string',
dataEncryptionMetadata={
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
queryLogStatus='ENABLED'|'DISABLED',
jobLogStatus='ENABLED'|'DISABLED',
tags={
'string': 'string'
},
creatorPaymentConfiguration={
'queryCompute': {
'isResponsible': True|False
},
'machineLearning': {
'modelTraining': {
'isResponsible': True|False
},
'modelInference': {
'isResponsible': True|False
}
},
'jobCompute': {
'isResponsible': True|False
}
},
analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL',
autoApprovedChangeRequestTypes=[
'ADD_MEMBER',
],
allowedResultRegions=[
'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
]
)
list
[REQUIRED]
A list of initial members, not including the creator. This list is immutable.
(dict) --
Basic metadata used to construct a new member.
accountId (string) -- [REQUIRED]
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
memberAbilities (list) -- [REQUIRED]
The abilities granted to the collaboration member.
(string) --
mlMemberAbilities (dict) --
The ML abilities granted to the collaboration member.
customMLMemberAbilities (list) -- [REQUIRED]
The custom ML member abilities for a collaboration member.
(string) --
displayName (string) -- [REQUIRED]
The member's display name.
paymentConfiguration (dict) --
The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
queryCompute (dict) -- [REQUIRED]
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
string
[REQUIRED]
The display name for a collaboration.
string
[REQUIRED]
A description of the collaboration provided by the collaboration owner.
list
[REQUIRED]
The abilities granted to the collaboration creator.
(string) --
dict
The ML abilities granted to the collaboration creator.
customMLMemberAbilities (list) -- [REQUIRED]
The custom ML member abilities for a collaboration member.
(string) --
string
[REQUIRED]
The display name of the collaboration creator.
dict
The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
allowCleartext (boolean) -- [REQUIRED]
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) -- [REQUIRED]
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) -- [REQUIRED]
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) -- [REQUIRED]
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
string
[REQUIRED]
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
string
Specifies whether job logs are enabled for this collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
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
The collaboration creator's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
queryCompute (dict) -- [REQUIRED]
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
machineLearning (dict) --
An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
modelTraining (dict) --
The payment responsibilities accepted by the member for model training.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
modelInference (dict) --
The payment responsibilities accepted by the member for model inference.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
jobCompute (dict) --
The compute configuration for the job.
isResponsible (boolean) -- [REQUIRED]
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
string
The analytics engine.
list
The types of change requests that are automatically approved for this collaboration.
(string) --
list
The Amazon Web Services Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.
(string) --
dict
Response Syntax
{
'collaboration': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creatorAccountId': 'string',
'creatorDisplayName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
'membershipId': 'string',
'membershipArn': 'string',
'dataEncryptionMetadata': {
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'jobLogStatus': 'ENABLED'|'DISABLED',
'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
'autoApprovedChangeTypes': [
'ADD_MEMBER',
],
'allowedResultRegions': [
'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
]
}
}
Response Structure
(dict) --
collaboration (dict) --
The collaboration.
id (string) --
The unique ID for the collaboration.
arn (string) --
The unique ARN for the collaboration.
name (string) --
A human-readable identifier provided by the collaboration owner. Display names are not unique.
description (string) --
A description of the collaboration provided by the collaboration owner.
creatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
creatorDisplayName (string) --
A display name of the collaboration creator.
createTime (datetime) --
The time when the collaboration was created.
updateTime (datetime) --
The time the collaboration metadata was last updated.
memberStatus (string) --
The status of a member in a collaboration.
membershipId (string) --
The unique ID for your membership within the collaboration.
membershipArn (string) --
The unique ARN for your membership within the collaboration.
dataEncryptionMetadata (dict) --
The settings for client-side encryption for cryptographic computing.
allowCleartext (boolean) --
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) --
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) --
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) --
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
jobLogStatus (string) --
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
analyticsEngine (string) --
The analytics engine for the collaboration.
autoApprovedChangeTypes (list) --
The types of change requests that are automatically approved for this collaboration.
(string) --
allowedResultRegions (list) --
The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
(string) --
{'tableReference': {'athena': {'region': 'us-west-1 | us-west-2 | us-east-1 | '
'us-east-2 | af-south-1 | ap-east-1 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | eu-west-3 | '
'eu-south-2 | eu-central-2 | '
'eu-central-1 | eu-north-1 | '
'eu-west-1 | eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1 | '
'ap-east-2'},
'glue': {'region': 'us-west-1 | us-west-2 | us-east-1 | '
'us-east-2 | af-south-1 | ap-east-1 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | eu-west-3 | '
'eu-south-2 | eu-central-2 | '
'eu-central-1 | eu-north-1 | eu-west-1 '
'| eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1 | ap-east-2'}}}
Response {'configuredTable': {'tableReference': {'athena': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'},
'glue': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'}}}}
Creates a new configured table resource.
See also: AWS API Documentation
Request Syntax
client.create_configured_table(
name='string',
description='string',
tableReference={
'glue': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'tableName': 'string',
'databaseName': 'string'
},
'snowflake': {
'secretArn': 'string',
'accountIdentifier': 'string',
'databaseName': 'string',
'tableName': 'string',
'schemaName': 'string',
'tableSchema': {
'v1': [
{
'columnName': 'string',
'columnType': 'string'
},
]
}
},
'athena': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'workGroup': 'string',
'outputLocation': 'string',
'databaseName': 'string',
'tableName': 'string'
}
},
allowedColumns=[
'string',
],
analysisMethod='DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
selectedAnalysisMethods=[
'DIRECT_QUERY'|'DIRECT_JOB',
],
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the configured table.
string
A description for the configured table.
dict
[REQUIRED]
A reference to the table being configured.
glue (dict) --
If present, a reference to the Glue table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.
tableName (string) -- [REQUIRED]
The name of the Glue table.
databaseName (string) -- [REQUIRED]
The name of the database the Glue table belongs to.
snowflake (dict) --
If present, a reference to the Snowflake table referred to by this table reference.
secretArn (string) -- [REQUIRED]
The secret ARN of the Snowflake table reference.
accountIdentifier (string) -- [REQUIRED]
The account identifier for the Snowflake table reference.
databaseName (string) -- [REQUIRED]
The name of the database the Snowflake table belongs to.
tableName (string) -- [REQUIRED]
The name of the Snowflake table.
schemaName (string) -- [REQUIRED]
The schema name of the Snowflake table reference.
tableSchema (dict) -- [REQUIRED]
The schema of the Snowflake table.
v1 (list) --
The schema of a Snowflake table.
(dict) --
The Snowflake table schema.
columnName (string) -- [REQUIRED]
The column name.
columnType (string) -- [REQUIRED]
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
athena (dict) --
If present, a reference to the Athena table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.
workGroup (string) -- [REQUIRED]
The workgroup of the Athena table reference.
outputLocation (string) --
The output location for the Athena table.
databaseName (string) -- [REQUIRED]
The database name.
tableName (string) -- [REQUIRED]
The table reference.
list
[REQUIRED]
The columns of the underlying table that can be used by collaborations or analysis rules.
(string) --
string
[REQUIRED]
The analysis method allowed for the configured tables.
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.
list
The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.
(string) --
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
{
'configuredTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'tableReference': {
'glue': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'tableName': 'string',
'databaseName': 'string'
},
'snowflake': {
'secretArn': 'string',
'accountIdentifier': 'string',
'databaseName': 'string',
'tableName': 'string',
'schemaName': 'string',
'tableSchema': {
'v1': [
{
'columnName': 'string',
'columnType': 'string'
},
]
}
},
'athena': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'workGroup': 'string',
'outputLocation': 'string',
'databaseName': 'string',
'tableName': 'string'
}
},
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'allowedColumns': [
'string',
],
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
]
}
}
Response Structure
(dict) --
configuredTable (dict) --
The created configured table.
id (string) --
The unique ID for the configured table.
arn (string) --
The unique ARN for the configured table.
name (string) --
A name for the configured table.
description (string) --
A description for the configured table.
tableReference (dict) --
The table that this configured table represents.
glue (dict) --
If present, a reference to the Glue table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.
tableName (string) --
The name of the Glue table.
databaseName (string) --
The name of the database the Glue table belongs to.
snowflake (dict) --
If present, a reference to the Snowflake table referred to by this table reference.
secretArn (string) --
The secret ARN of the Snowflake table reference.
accountIdentifier (string) --
The account identifier for the Snowflake table reference.
databaseName (string) --
The name of the database the Snowflake table belongs to.
tableName (string) --
The name of the Snowflake table.
schemaName (string) --
The schema name of the Snowflake table reference.
tableSchema (dict) --
The schema of the Snowflake table.
v1 (list) --
The schema of a Snowflake table.
(dict) --
The Snowflake table schema.
columnName (string) --
The column name.
columnType (string) --
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
athena (dict) --
If present, a reference to the Athena table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.
workGroup (string) --
The workgroup of the Athena table reference.
outputLocation (string) --
The output location for the Athena table.
databaseName (string) --
The database name.
tableName (string) --
The table reference.
createTime (datetime) --
The time the configured table was created.
updateTime (datetime) --
The time the configured table was last updated
analysisRuleTypes (list) --
The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
(string) --
analysisMethod (string) --
The analysis method for the configured table.
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.
allowedColumns (list) --
The columns within the underlying Glue table that can be utilized within collaborations.
(string) --
selectedAnalysisMethods (list) --
The selected analysis methods for the configured table.
(string) --
{'collaboration': {'allowedResultRegions': ['us-west-1 | us-west-2 | us-east-1 '
'| us-east-2 | af-south-1 | '
'ap-east-1 | ap-east-2 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | '
'eu-west-3 | eu-south-2 | '
'eu-central-2 | eu-central-1 | '
'eu-north-1 | eu-west-1 | '
'eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1']}}
Returns metadata about a collaboration.
See also: AWS API Documentation
Request Syntax
client.get_collaboration(
collaborationIdentifier='string'
)
string
[REQUIRED]
The identifier for the collaboration.
dict
Response Syntax
{
'collaboration': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creatorAccountId': 'string',
'creatorDisplayName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
'membershipId': 'string',
'membershipArn': 'string',
'dataEncryptionMetadata': {
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'jobLogStatus': 'ENABLED'|'DISABLED',
'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
'autoApprovedChangeTypes': [
'ADD_MEMBER',
],
'allowedResultRegions': [
'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
]
}
}
Response Structure
(dict) --
collaboration (dict) --
The entire collaboration for this identifier.
id (string) --
The unique ID for the collaboration.
arn (string) --
The unique ARN for the collaboration.
name (string) --
A human-readable identifier provided by the collaboration owner. Display names are not unique.
description (string) --
A description of the collaboration provided by the collaboration owner.
creatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
creatorDisplayName (string) --
A display name of the collaboration creator.
createTime (datetime) --
The time when the collaboration was created.
updateTime (datetime) --
The time the collaboration metadata was last updated.
memberStatus (string) --
The status of a member in a collaboration.
membershipId (string) --
The unique ID for your membership within the collaboration.
membershipArn (string) --
The unique ARN for your membership within the collaboration.
dataEncryptionMetadata (dict) --
The settings for client-side encryption for cryptographic computing.
allowCleartext (boolean) --
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) --
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) --
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) --
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
jobLogStatus (string) --
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
analyticsEngine (string) --
The analytics engine for the collaboration.
autoApprovedChangeTypes (list) --
The types of change requests that are automatically approved for this collaboration.
(string) --
allowedResultRegions (list) --
The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
(string) --
{'configuredTable': {'tableReference': {'athena': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'},
'glue': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'}}}}
Retrieves a configured table.
See also: AWS API Documentation
Request Syntax
client.get_configured_table(
configuredTableIdentifier='string'
)
string
[REQUIRED]
The unique ID for the configured table to retrieve.
dict
Response Syntax
{
'configuredTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'tableReference': {
'glue': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'tableName': 'string',
'databaseName': 'string'
},
'snowflake': {
'secretArn': 'string',
'accountIdentifier': 'string',
'databaseName': 'string',
'tableName': 'string',
'schemaName': 'string',
'tableSchema': {
'v1': [
{
'columnName': 'string',
'columnType': 'string'
},
]
}
},
'athena': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'workGroup': 'string',
'outputLocation': 'string',
'databaseName': 'string',
'tableName': 'string'
}
},
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'allowedColumns': [
'string',
],
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
]
}
}
Response Structure
(dict) --
configuredTable (dict) --
The retrieved configured table.
id (string) --
The unique ID for the configured table.
arn (string) --
The unique ARN for the configured table.
name (string) --
A name for the configured table.
description (string) --
A description for the configured table.
tableReference (dict) --
The table that this configured table represents.
glue (dict) --
If present, a reference to the Glue table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.
tableName (string) --
The name of the Glue table.
databaseName (string) --
The name of the database the Glue table belongs to.
snowflake (dict) --
If present, a reference to the Snowflake table referred to by this table reference.
secretArn (string) --
The secret ARN of the Snowflake table reference.
accountIdentifier (string) --
The account identifier for the Snowflake table reference.
databaseName (string) --
The name of the database the Snowflake table belongs to.
tableName (string) --
The name of the Snowflake table.
schemaName (string) --
The schema name of the Snowflake table reference.
tableSchema (dict) --
The schema of the Snowflake table.
v1 (list) --
The schema of a Snowflake table.
(dict) --
The Snowflake table schema.
columnName (string) --
The column name.
columnType (string) --
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
athena (dict) --
If present, a reference to the Athena table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.
workGroup (string) --
The workgroup of the Athena table reference.
outputLocation (string) --
The output location for the Athena table.
databaseName (string) --
The database name.
tableName (string) --
The table reference.
createTime (datetime) --
The time the configured table was created.
updateTime (datetime) --
The time the configured table was last updated
analysisRuleTypes (list) --
The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
(string) --
analysisMethod (string) --
The analysis method for the configured table.
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.
allowedColumns (list) --
The columns within the underlying Glue table that can be utilized within collaborations.
(string) --
selectedAnalysisMethods (list) --
The selected analysis methods for the configured table.
(string) --
{'collaboration': {'allowedResultRegions': ['us-west-1 | us-west-2 | us-east-1 '
'| us-east-2 | af-south-1 | '
'ap-east-1 | ap-east-2 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | '
'eu-west-3 | eu-south-2 | '
'eu-central-2 | eu-central-1 | '
'eu-north-1 | eu-west-1 | '
'eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1']}}
Updates collaboration metadata and can only be called by the collaboration owner.
See also: AWS API Documentation
Request Syntax
client.update_collaboration(
collaborationIdentifier='string',
name='string',
description='string',
analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)
string
[REQUIRED]
The identifier for the collaboration.
string
A human-readable identifier provided by the collaboration owner. Display names are not unique.
string
A description of the collaboration.
string
The analytics engine.
dict
Response Syntax
{
'collaboration': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'creatorAccountId': 'string',
'creatorDisplayName': 'string',
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
'membershipId': 'string',
'membershipArn': 'string',
'dataEncryptionMetadata': {
'allowCleartext': True|False,
'allowDuplicates': True|False,
'allowJoinsOnColumnsWithDifferentNames': True|False,
'preserveNulls': True|False
},
'queryLogStatus': 'ENABLED'|'DISABLED',
'jobLogStatus': 'ENABLED'|'DISABLED',
'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
'autoApprovedChangeTypes': [
'ADD_MEMBER',
],
'allowedResultRegions': [
'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
]
}
}
Response Structure
(dict) --
collaboration (dict) --
The entire collaboration that has been updated.
id (string) --
The unique ID for the collaboration.
arn (string) --
The unique ARN for the collaboration.
name (string) --
A human-readable identifier provided by the collaboration owner. Display names are not unique.
description (string) --
A description of the collaboration provided by the collaboration owner.
creatorAccountId (string) --
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
creatorDisplayName (string) --
A display name of the collaboration creator.
createTime (datetime) --
The time when the collaboration was created.
updateTime (datetime) --
The time the collaboration metadata was last updated.
memberStatus (string) --
The status of a member in a collaboration.
membershipId (string) --
The unique ID for your membership within the collaboration.
membershipArn (string) --
The unique ARN for your membership within the collaboration.
dataEncryptionMetadata (dict) --
The settings for client-side encryption for cryptographic computing.
allowCleartext (boolean) --
Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).
allowDuplicates (boolean) --
Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).
allowJoinsOnColumnsWithDifferentNames (boolean) --
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).
preserveNulls (boolean) --
Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).
queryLogStatus (string) --
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
jobLogStatus (string) --
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
analyticsEngine (string) --
The analytics engine for the collaboration.
autoApprovedChangeTypes (list) --
The types of change requests that are automatically approved for this collaboration.
(string) --
allowedResultRegions (list) --
The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
(string) --
{'tableReference': {'athena': {'region': 'us-west-1 | us-west-2 | us-east-1 | '
'us-east-2 | af-south-1 | ap-east-1 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | eu-west-3 | '
'eu-south-2 | eu-central-2 | '
'eu-central-1 | eu-north-1 | '
'eu-west-1 | eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1 | '
'ap-east-2'},
'glue': {'region': 'us-west-1 | us-west-2 | us-east-1 | '
'us-east-2 | af-south-1 | ap-east-1 | '
'ap-south-2 | ap-southeast-1 | '
'ap-southeast-2 | ap-southeast-3 | '
'ap-southeast-5 | ap-southeast-4 | '
'ap-southeast-7 | ap-south-1 | '
'ap-northeast-3 | ap-northeast-1 | '
'ap-northeast-2 | ca-central-1 | '
'ca-west-1 | eu-south-1 | eu-west-3 | '
'eu-south-2 | eu-central-2 | '
'eu-central-1 | eu-north-1 | eu-west-1 '
'| eu-west-2 | me-south-1 | '
'me-central-1 | il-central-1 | '
'sa-east-1 | mx-central-1 | ap-east-2'}}}
Response {'configuredTable': {'tableReference': {'athena': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'},
'glue': {'region': 'us-west-1 | '
'us-west-2 | '
'us-east-1 | '
'us-east-2 | '
'af-south-1 | '
'ap-east-1 | '
'ap-south-2 | '
'ap-southeast-1 | '
'ap-southeast-2 | '
'ap-southeast-3 | '
'ap-southeast-5 | '
'ap-southeast-4 | '
'ap-southeast-7 | '
'ap-south-1 | '
'ap-northeast-3 | '
'ap-northeast-1 | '
'ap-northeast-2 | '
'ca-central-1 | '
'ca-west-1 | '
'eu-south-1 | '
'eu-west-3 | '
'eu-south-2 | '
'eu-central-2 | '
'eu-central-1 | '
'eu-north-1 | '
'eu-west-1 | '
'eu-west-2 | '
'me-south-1 | '
'me-central-1 | '
'il-central-1 | '
'sa-east-1 | '
'mx-central-1 | '
'ap-east-2'}}}}
Updates a configured table.
See also: AWS API Documentation
Request Syntax
client.update_configured_table(
configuredTableIdentifier='string',
name='string',
description='string',
tableReference={
'glue': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'tableName': 'string',
'databaseName': 'string'
},
'snowflake': {
'secretArn': 'string',
'accountIdentifier': 'string',
'databaseName': 'string',
'tableName': 'string',
'schemaName': 'string',
'tableSchema': {
'v1': [
{
'columnName': 'string',
'columnType': 'string'
},
]
}
},
'athena': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'workGroup': 'string',
'outputLocation': 'string',
'databaseName': 'string',
'tableName': 'string'
}
},
allowedColumns=[
'string',
],
analysisMethod='DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
selectedAnalysisMethods=[
'DIRECT_QUERY'|'DIRECT_JOB',
]
)
string
[REQUIRED]
The identifier for the configured table to update. Currently accepts the configured table ID.
string
A new name for the configured table.
string
A new description for the configured table.
dict
A pointer to the dataset that underlies this table.
glue (dict) --
If present, a reference to the Glue table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.
tableName (string) -- [REQUIRED]
The name of the Glue table.
databaseName (string) -- [REQUIRED]
The name of the database the Glue table belongs to.
snowflake (dict) --
If present, a reference to the Snowflake table referred to by this table reference.
secretArn (string) -- [REQUIRED]
The secret ARN of the Snowflake table reference.
accountIdentifier (string) -- [REQUIRED]
The account identifier for the Snowflake table reference.
databaseName (string) -- [REQUIRED]
The name of the database the Snowflake table belongs to.
tableName (string) -- [REQUIRED]
The name of the Snowflake table.
schemaName (string) -- [REQUIRED]
The schema name of the Snowflake table reference.
tableSchema (dict) -- [REQUIRED]
The schema of the Snowflake table.
v1 (list) --
The schema of a Snowflake table.
(dict) --
The Snowflake table schema.
columnName (string) -- [REQUIRED]
The column name.
columnType (string) -- [REQUIRED]
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
athena (dict) --
If present, a reference to the Athena table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.
workGroup (string) -- [REQUIRED]
The workgroup of the Athena table reference.
outputLocation (string) --
The output location for the Athena table.
databaseName (string) -- [REQUIRED]
The database name.
tableName (string) -- [REQUIRED]
The table reference.
list
The columns of the underlying table that can be used by collaborations or analysis rules.
(string) --
string
The analysis method for the configured table.
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.
list
The selected analysis methods for the table configuration update.
(string) --
dict
Response Syntax
{
'configuredTable': {
'id': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'tableReference': {
'glue': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'tableName': 'string',
'databaseName': 'string'
},
'snowflake': {
'secretArn': 'string',
'accountIdentifier': 'string',
'databaseName': 'string',
'tableName': 'string',
'schemaName': 'string',
'tableSchema': {
'v1': [
{
'columnName': 'string',
'columnType': 'string'
},
]
}
},
'athena': {
'region': 'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1'|'ap-east-2',
'workGroup': 'string',
'outputLocation': 'string',
'databaseName': 'string',
'tableName': 'string'
}
},
'createTime': datetime(2015, 1, 1),
'updateTime': datetime(2015, 1, 1),
'analysisRuleTypes': [
'AGGREGATION'|'LIST'|'CUSTOM',
],
'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
'allowedColumns': [
'string',
],
'selectedAnalysisMethods': [
'DIRECT_QUERY'|'DIRECT_JOB',
]
}
}
Response Structure
(dict) --
configuredTable (dict) --
The updated configured table.
id (string) --
The unique ID for the configured table.
arn (string) --
The unique ARN for the configured table.
name (string) --
A name for the configured table.
description (string) --
A description for the configured table.
tableReference (dict) --
The table that this configured table represents.
glue (dict) --
If present, a reference to the Glue table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Glue table is located. This parameter is required to uniquely identify and access tables across different Regions.
tableName (string) --
The name of the Glue table.
databaseName (string) --
The name of the database the Glue table belongs to.
snowflake (dict) --
If present, a reference to the Snowflake table referred to by this table reference.
secretArn (string) --
The secret ARN of the Snowflake table reference.
accountIdentifier (string) --
The account identifier for the Snowflake table reference.
databaseName (string) --
The name of the database the Snowflake table belongs to.
tableName (string) --
The name of the Snowflake table.
schemaName (string) --
The schema name of the Snowflake table reference.
tableSchema (dict) --
The schema of the Snowflake table.
v1 (list) --
The schema of a Snowflake table.
(dict) --
The Snowflake table schema.
columnName (string) --
The column name.
columnType (string) --
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
athena (dict) --
If present, a reference to the Athena table referred to by this table reference.
region (string) --
The Amazon Web Services Region where the Athena table is located. This parameter is required to uniquely identify and access tables across different Regions.
workGroup (string) --
The workgroup of the Athena table reference.
outputLocation (string) --
The output location for the Athena table.
databaseName (string) --
The database name.
tableName (string) --
The table reference.
createTime (datetime) --
The time the configured table was created.
updateTime (datetime) --
The time the configured table was last updated
analysisRuleTypes (list) --
The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
(string) --
analysisMethod (string) --
The analysis method for the configured table.
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.
allowedColumns (list) --
The columns within the underlying Glue table that can be utilized within collaborations.
(string) --
selectedAnalysisMethods (list) --
The selected analysis methods for the configured table.
(string) --