AWS Clean Rooms Service

2025/07/29 - AWS Clean Rooms Service - 1 updated api methods

Changes  This feature provides the ability to update the table reference and allowed columns on an existing configured table.

UpdateConfiguredTable (updated) Link ΒΆ
Changes (request)
{'allowedColumns': ['string'],
 'tableReference': {'athena': {'databaseName': 'string',
                               'outputLocation': 'string',
                               'tableName': 'string',
                               'workGroup': 'string'},
                    'glue': {'databaseName': 'string', 'tableName': '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',
    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'|'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.

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

    • 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:

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': {
                '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'|'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.

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

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