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'
        }
    },
    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 AWS Glue table being configured.

  Note

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

  • glue (dict) –

    If present, a reference to the AWS Glue table referred to by this table reference.

    • tableName (string) – [REQUIRED]

      The name of the AWS Glue table.

    • databaseName (string) – [REQUIRED]

      The name of the database the AWS Glue table belongs to.

• 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'
            }
        },
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'analysisRuleTypes': [
            'AGGREGATION'|'LIST',
        ],
        '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 AWS Glue 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. 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 AWS Glue table referred to by this table reference.

        • tableName (string) –

          The name of the AWS Glue table.

        • databaseName (string) –

          The name of the database the AWS Glue table belongs to.

    • 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. Valid values are AGGREGATION and LIST. 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 AWS 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