Connect / Client / create_data_table

create_data_table

Connect.Client.create_data_table(**kwargs)

Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using AWS Service Quotas.

See also: AWS API Documentation

Request Syntax

response = client.create_data_table(
    InstanceId='string',
    Name='string',
    Description='string',
    TimeZone='string',
    ValueLockLevel='NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
    Status='PUBLISHED',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The unique identifier for the Amazon Connect instance where the data table will be created.

  • Name (string) –

    [REQUIRED]

    The name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values ‘connect:’ and ‘aws:’. Must be unique for the instance using case-insensitive comparison.

  • Description (string) – An optional description for the data table. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace must be trimmed first.

  • TimeZone (string) –

    [REQUIRED]

    The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices are specified.

  • ValueLockLevel (string) –

    [REQUIRED]

    The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

  • Status (string) –

    [REQUIRED]

    The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of the table.

  • Tags (dict) –

    Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for organization and access control purposes.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'Arn': 'string',
    'LockVersion': {
        'DataTable': 'string',
        'Attribute': 'string',
        'PrimaryValues': 'string',
        'Value': 'string'
    }
}

Response Structure

  • (dict) –

    • Id (string) –

      The unique identifier for the created data table. Does not include the version alias.

    • Arn (string) –

      The Amazon Resource Name (ARN) for the created data table. Does not include the version alias.

    • LockVersion (dict) –

      The lock version information for the created data table, used for optimistic locking and table versioning.

      • DataTable (string) –

        The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table’s metadata or structure.

      • Attribute (string) –

        The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute’s properties are directly updated.

      • PrimaryValues (string) –

        The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.

      • Value (string) –

        The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.

Exceptions