AWS API Changes

2024/12/02 - AWS Clean Rooms Service - 3 updated api methods

Changes This release allows customers and their partners to easily collaborate with data stored in Snowflake and Amazon Athena, without having to move or share their underlying data among collaborators.

CreateConfiguredTable (updated)

Link ¶
Changes (request, response)
Request

{'tableReference': {'athena': {'databaseName': 'string',
                               'outputLocation': 'string',
                               'tableName': 'string',
                               'workGroup': 'string'},
                    'snowflake': {'accountIdentifier': 'string',
                                  'databaseName': 'string',
                                  'schemaName': 'string',
                                  'secretArn': 'string',
                                  'tableName': 'string',
                                  'tableSchema': {'v1': [{'columnName': 'string',
                                                          'columnType': 'string'}]}}}}

Response

{'configuredTable': {'tableReference': {'athena': {'databaseName': 'string',
                                                   'outputLocation': 'string',
                                                   'tableName': 'string',
                                                   'workGroup': 'string'},
                                        'snowflake': {'accountIdentifier': 'string',
                                                      'databaseName': 'string',
                                                      'schemaName': 'string',
                                                      'secretArn': 'string',
                                                      'tableName': 'string',
                                                      'tableSchema': {'v1': [{'columnName': 'string',
                                                                              'columnType': 'string'}]}}}}}

Creates a new configured table resource.

See also: AWS API Documentation

Request Syntax

client.create_configured_table(
    name='string',
    description='string',
    tableReference={
        'glue': {
            'tableName': 'string',
            'databaseName': 'string'
        },
        'snowflake': {
            'secretArn': 'string',
            'accountIdentifier': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'schemaName': 'string',
            'tableSchema': {
                'v1': [
                    {
                        'columnName': 'string',
                        'columnType': 'string'
                    },
                ]
            }
        },
        'athena': {
            'workGroup': 'string',
            'outputLocation': 'string',
            'databaseName': 'string',
            'tableName': 'string'
        }
    },
    allowedColumns=[
        'string',
    ],
    analysisMethod='DIRECT_QUERY',
    tags={
        'string': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name of the configured table.

type description:

string

param description:

A description for the configured table.

type tableReference:

dict

param tableReference:

[REQUIRED]

A reference to the table being configured.

glue (dict) --

If present, a reference to the Glue table referred to by this table reference.
- 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.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: v1.
  - 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.
- 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.

type allowedColumns:

list

param allowedColumns:

[REQUIRED]

The columns of the underlying table that can be used by collaborations or analysis rules.

(string) --

type analysisMethod:

string

param analysisMethod:

[REQUIRED]

The analysis method for the configured tables. The only valid value is currently DIRECT_QUERY.

type tags:

dict

param tags:

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) --

rtype:

dict

returns:

Response Syntax

{
    'configuredTable': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'tableReference': {
            'glue': {
                'tableName': 'string',
                'databaseName': 'string'
            },
            'snowflake': {
                'secretArn': 'string',
                'accountIdentifier': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'schemaName': 'string',
                'tableSchema': {
                    'v1': [
                        {
                            'columnName': 'string',
                            'columnType': 'string'
                        },
                    ]
                }
            },
            'athena': {
                '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',
        'allowedColumns': [
            'string',
        ]
    }
}

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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - glue (dict) --
      
      If present, a reference to the Glue table referred to by this table reference.
      - 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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: v1. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
      - 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. The only valid value is currently DIRECT_QUERY.
  - allowedColumns (list) --
    
    The columns within the underlying Glue table that can be utilized within collaborations.
    - (string) --

GetConfiguredTable (updated)

Link ¶
Changes (response)

{'configuredTable': {'tableReference': {'athena': {'databaseName': 'string',
                                                   'outputLocation': 'string',
                                                   'tableName': 'string',
                                                   'workGroup': 'string'},
                                        'snowflake': {'accountIdentifier': 'string',
                                                      'databaseName': 'string',
                                                      'schemaName': 'string',
                                                      'secretArn': 'string',
                                                      'tableName': 'string',
                                                      'tableSchema': {'v1': [{'columnName': 'string',
                                                                              'columnType': 'string'}]}}}}}

Retrieves a configured table.

See also: AWS API Documentation

Request Syntax

client.get_configured_table(
    configuredTableIdentifier='string'
)

type configuredTableIdentifier:

string

param configuredTableIdentifier:

[REQUIRED]

The unique ID for the configured table to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'configuredTable': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'tableReference': {
            'glue': {
                'tableName': 'string',
                'databaseName': 'string'
            },
            'snowflake': {
                'secretArn': 'string',
                'accountIdentifier': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'schemaName': 'string',
                'tableSchema': {
                    'v1': [
                        {
                            'columnName': 'string',
                            'columnType': 'string'
                        },
                    ]
                }
            },
            'athena': {
                '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',
        'allowedColumns': [
            'string',
        ]
    }
}

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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - glue (dict) --
      
      If present, a reference to the Glue table referred to by this table reference.
      - 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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: v1. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
      - 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. The only valid value is currently DIRECT_QUERY.
  - allowedColumns (list) --
    
    The columns within the underlying Glue table that can be utilized within collaborations.
    - (string) --

UpdateConfiguredTable (updated)

Link ¶
Changes (response)

{'configuredTable': {'tableReference': {'athena': {'databaseName': 'string',
                                                   'outputLocation': 'string',
                                                   'tableName': 'string',
                                                   'workGroup': 'string'},
                                        'snowflake': {'accountIdentifier': 'string',
                                                      'databaseName': 'string',
                                                      'schemaName': 'string',
                                                      'secretArn': 'string',
                                                      'tableName': 'string',
                                                      'tableSchema': {'v1': [{'columnName': 'string',
                                                                              'columnType': 'string'}]}}}}}

Updates a configured table.

See also: AWS API Documentation

Request Syntax

client.update_configured_table(
    configuredTableIdentifier='string',
    name='string',
    description='string'
)

type configuredTableIdentifier:

string

param configuredTableIdentifier:

[REQUIRED]

The identifier for the configured table to update. Currently accepts the configured table ID.

type name:

string

param name:

A new name for the configured table.

type description:

string

param description:

A new description for the configured table.

rtype:

dict

returns:

Response Syntax

{
    'configuredTable': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'tableReference': {
            'glue': {
                'tableName': 'string',
                'databaseName': 'string'
            },
            'snowflake': {
                'secretArn': 'string',
                'accountIdentifier': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'schemaName': 'string',
                'tableSchema': {
                    'v1': [
                        {
                            'columnName': 'string',
                            'columnType': 'string'
                        },
                    ]
                }
            },
            'athena': {
                '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',
        'allowedColumns': [
            'string',
        ]
    }
}

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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - glue (dict) --
      
      If present, a reference to the Glue table referred to by this table reference.
      - 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.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: v1. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
      - 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. The only valid value is currently DIRECT_QUERY.
  - allowedColumns (list) --
    
    The columns within the underlying Glue table that can be utilized within collaborations.
    - (string) --