AWS API Changes

2026/10/20 - AWS Clean Rooms Service - 4 updated api methods

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

CreateConfiguredTable (updated)

Link ¶
Changes (request, response)
Request

{'tableReference': {'databricks': {'connectionType': {'deltaSharing': {'deltaShareEndpoint': 'string',
                                                                       'shareName': 'string'}},
                                   'schemaName': 'string',
                                   'tableName': 'string',
                                   'workspaceUrl': 'string'}}}

Response

{'configuredTable': {'tableReference': {'databricks': {'connectionType': {'deltaSharing': {'deltaShareEndpoint': 'string',
                                                                                           'shareName': 'string'}},
                                                       'schemaName': 'string',
                                                       'tableName': 'string',
                                                       'workspaceUrl': 'string'}},
                     'tableType': 'GLUE | SNOWFLAKE | ATHENA | DATABRICKS'}}

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',
            'catalogName': 'string'
        },
        'databricks': {
            'schemaName': 'string',
            'tableName': 'string',
            'workspaceUrl': 'string',
            'connectionType': {
                'deltaSharing': {
                    'deltaShareEndpoint': 'string',
                    'shareName': 'string'
                }
            }
        }
    },
    allowedColumns=[
        'string',
    ],
    analysisMethod='DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
    selectedAnalysisMethods=[
        'DIRECT_QUERY'|'DIRECT_JOB',
    ],
    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.
- 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.
  
  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.
- 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.
- catalogName (string) --
  
  The catalog name.
databricks (dict) --

If present, a reference to the Databricks table referred to by this table reference.
- schemaName (string) -- [REQUIRED]
  
  Name of the Schema within Databricks.
- tableName (string) -- [REQUIRED]
  
  Name of the Table within Databricks.
- workspaceUrl (string) -- [REQUIRED]
  
  URL for the Databricks Workspace.
- connectionType (dict) -- [REQUIRED]
  
  Type of the connector to be used for connecting to Databricks. Supported connector: Delta Sharing
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: deltaSharing.
  - deltaSharing (dict) --
    
    Details about Connector for Databricks
    - deltaShareEndpoint (string) -- [REQUIRED]
      
      The base URL of a Delta Sharing server that hosts shared datasets.
    - shareName (string) -- [REQUIRED]
      
      Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.

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

type selectedAnalysisMethods:

list

param selectedAnalysisMethods:

The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.

(string) --

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': {
                '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',
                'catalogName': 'string'
            },
            'databricks': {
                'schemaName': 'string',
                'tableName': 'string',
                'workspaceUrl': 'string',
                'connectionType': {
                    'deltaSharing': {
                        'deltaShareEndpoint': 'string',
                        'shareName': 'string'
                    }
                }
            }
        },
        'tableType': 'GLUE'|'SNOWFLAKE'|'ATHENA'|'DATABRICKS',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena, databricks. 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.
      - 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.
        
        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.
      - 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.
      - catalogName (string) --
        
        The catalog name.
    - databricks (dict) --
      
      If present, a reference to the Databricks table referred to by this table reference.
      - schemaName (string) --
        
        Name of the Schema within Databricks.
      - tableName (string) --
        
        Name of the Table within Databricks.
      - workspaceUrl (string) --
        
        URL for the Databricks Workspace.
      - connectionType (dict) --
        
        Type of the connector to be used for connecting to Databricks. Supported connector: Delta Sharing
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: deltaSharing. 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'}
        
        deltaSharing (dict) --
        
        Details about Connector for Databricks
        
        deltaShareEndpoint (string) --
        
        The base URL of a Delta Sharing server that hosts shared datasets.
        
        shareName (string) --
        
        Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.
  - tableType (string) --
    
    Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks
  - 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 used within collaborations.
    - (string) --
  - selectedAnalysisMethods (list) --
    
    The selected analysis methods for the configured table.
    - (string) --

GetConfiguredTable (updated)

Link ¶
Changes (response)

{'configuredTable': {'tableReference': {'databricks': {'connectionType': {'deltaSharing': {'deltaShareEndpoint': 'string',
                                                                                           'shareName': 'string'}},
                                                       'schemaName': 'string',
                                                       'tableName': 'string',
                                                       'workspaceUrl': 'string'}},
                     'tableType': 'GLUE | SNOWFLAKE | ATHENA | DATABRICKS'}}

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': {
                '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',
                'catalogName': 'string'
            },
            'databricks': {
                'schemaName': 'string',
                'tableName': 'string',
                'workspaceUrl': 'string',
                'connectionType': {
                    'deltaSharing': {
                        'deltaShareEndpoint': 'string',
                        'shareName': 'string'
                    }
                }
            }
        },
        'tableType': 'GLUE'|'SNOWFLAKE'|'ATHENA'|'DATABRICKS',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena, databricks. 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.
      - 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.
        
        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.
      - 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.
      - catalogName (string) --
        
        The catalog name.
    - databricks (dict) --
      
      If present, a reference to the Databricks table referred to by this table reference.
      - schemaName (string) --
        
        Name of the Schema within Databricks.
      - tableName (string) --
        
        Name of the Table within Databricks.
      - workspaceUrl (string) --
        
        URL for the Databricks Workspace.
      - connectionType (dict) --
        
        Type of the connector to be used for connecting to Databricks. Supported connector: Delta Sharing
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: deltaSharing. 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'}
        
        deltaSharing (dict) --
        
        Details about Connector for Databricks
        
        deltaShareEndpoint (string) --
        
        The base URL of a Delta Sharing server that hosts shared datasets.
        
        shareName (string) --
        
        Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.
  - tableType (string) --
    
    Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks
  - 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 used within collaborations.
    - (string) --
  - selectedAnalysisMethods (list) --
    
    The selected analysis methods for the configured table.
    - (string) --

ListConfiguredTables (updated)

Link ¶
Changes (response)

{'configuredTableSummaries': {'tableType': 'GLUE | SNOWFLAKE | ATHENA | '
                                           'DATABRICKS'}}

Lists configured tables.

See also: AWS API Documentation

Request Syntax

client.list_configured_tables(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

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.

rtype:

dict

returns:

Response Syntax

{
    'configuredTableSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'tableType': 'GLUE'|'SNOWFLAKE'|'ATHENA'|'DATABRICKS',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'analysisRuleTypes': [
                'AGGREGATION'|'LIST'|'CUSTOM',
            ],
            'analysisMethod': 'DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
            'selectedAnalysisMethods': [
                'DIRECT_QUERY'|'DIRECT_JOB',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- configuredTableSummaries (list) --
  
  The configured tables listed by the request.
  - (dict) --
    
    The member of the configured table summary list.
    - id (string) --
      
      The unique ID of the configured table.
    - arn (string) --
      
      The unique ARN of the configured table.
    - name (string) --
      
      The name of the configured table.
    - tableType (string) --
      
      Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks
    - 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.
      - (string) --
    - analysisMethod (string) --
      
      The analysis method 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.
    - selectedAnalysisMethods (list) --
      
      The selected analysis methods for the configured table summary.
      - (string) --
- nextToken (string) --
  
  The pagination token that's used to fetch the next set of results.

UpdateConfiguredTable (updated)

Link ¶
Changes (request, response)
Request

{'tableReference': {'databricks': {'connectionType': {'deltaSharing': {'deltaShareEndpoint': 'string',
                                                                       'shareName': 'string'}},
                                   'schemaName': 'string',
                                   'tableName': 'string',
                                   'workspaceUrl': 'string'}}}

Response

{'configuredTable': {'tableReference': {'databricks': {'connectionType': {'deltaSharing': {'deltaShareEndpoint': 'string',
                                                                                           'shareName': 'string'}},
                                                       'schemaName': 'string',
                                                       'tableName': 'string',
                                                       'workspaceUrl': 'string'}},
                     'tableType': 'GLUE | SNOWFLAKE | ATHENA | DATABRICKS'}}

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',
            'catalogName': 'string'
        },
        'databricks': {
            'schemaName': 'string',
            'tableName': 'string',
            'workspaceUrl': 'string',
            'connectionType': {
                'deltaSharing': {
                    'deltaShareEndpoint': 'string',
                    'shareName': 'string'
                }
            }
        }
    },
    allowedColumns=[
        'string',
    ],
    analysisMethod='DIRECT_QUERY'|'DIRECT_JOB'|'MULTIPLE',
    selectedAnalysisMethods=[
        'DIRECT_QUERY'|'DIRECT_JOB',
    ]
)

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.

type tableReference:

dict

param tableReference:

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.
  
  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.
- 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.
- catalogName (string) --
  
  The catalog name.
databricks (dict) --

If present, a reference to the Databricks table referred to by this table reference.
- schemaName (string) -- [REQUIRED]
  
  Name of the Schema within Databricks.
- tableName (string) -- [REQUIRED]
  
  Name of the Table within Databricks.
- workspaceUrl (string) -- [REQUIRED]
  
  URL for the Databricks Workspace.
- connectionType (dict) -- [REQUIRED]
  
  Type of the connector to be used for connecting to Databricks. Supported connector: Delta Sharing
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: deltaSharing.
  - deltaSharing (dict) --
    
    Details about Connector for Databricks
    - deltaShareEndpoint (string) -- [REQUIRED]
      
      The base URL of a Delta Sharing server that hosts shared datasets.
    - shareName (string) -- [REQUIRED]
      
      Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.

type allowedColumns:

list

param allowedColumns:

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

(string) --

type analysisMethod:

string

param analysisMethod:

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.

type selectedAnalysisMethods:

list

param selectedAnalysisMethods:

The selected analysis methods for the table configuration update.

(string) --

rtype:

dict

returns:

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',
                'catalogName': 'string'
            },
            'databricks': {
                'schemaName': 'string',
                'tableName': 'string',
                'workspaceUrl': 'string',
                'connectionType': {
                    'deltaSharing': {
                        'deltaShareEndpoint': 'string',
                        'shareName': 'string'
                    }
                }
            }
        },
        'tableType': 'GLUE'|'SNOWFLAKE'|'ATHENA'|'DATABRICKS',
        '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.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: glue, snowflake, athena, databricks. 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.
      - 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.
        
        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.
      - 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.
      - catalogName (string) --
        
        The catalog name.
    - databricks (dict) --
      
      If present, a reference to the Databricks table referred to by this table reference.
      - schemaName (string) --
        
        Name of the Schema within Databricks.
      - tableName (string) --
        
        Name of the Table within Databricks.
      - workspaceUrl (string) --
        
        URL for the Databricks Workspace.
      - connectionType (dict) --
        
        Type of the connector to be used for connecting to Databricks. Supported connector: Delta Sharing
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: deltaSharing. 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'}
        
        deltaSharing (dict) --
        
        Details about Connector for Databricks
        
        deltaShareEndpoint (string) --
        
        The base URL of a Delta Sharing server that hosts shared datasets.
        
        shareName (string) --
        
        Name of the Share used for OpenSharing (Delta Sharing) the Databricks Table.
  - tableType (string) --
    
    Type of the Configured Table DataSource, example: Glue, Snowflake, Athena, Databricks
  - 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 used within collaborations.
    - (string) --
  - selectedAnalysisMethods (list) --
    
    The selected analysis methods for the configured table.
    - (string) --