CleanRoomsService / Client / create_configured_table

create_configured_table

CleanRoomsService.Client.create_configured_table(**kwargs)

Creates a new configured table resource.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  The name of the configured table.

• description (string) – A description for the configured table.

• tableReference (dict) –

  [REQUIRED]

  A reference to the table being configured.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: glue, snowflake, athena.

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

• allowedColumns (list) –

  [REQUIRED]

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

  • (string) –

• analysisMethod (string) –

  [REQUIRED]

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

• tags (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) –

Return type:

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

Exceptions

• CleanRoomsService.Client.exceptions.ConflictException

• CleanRoomsService.Client.exceptions.ServiceQuotaExceededException

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException