Connect / Client / describe_data_table

describe_data_table

Connect.Client.describe_data_table(**kwargs)

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. “Describe” is a deprecated term but is allowed to maintain consistency with existing operations.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_table(
    InstanceId='string',
    DataTableId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The unique identifier for the Amazon Connect instance.

  • DataTableId (string) –

    [REQUIRED]

    The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

Return type:

dict

Returns:

Response Syntax

{
    'DataTable': {
        'Name': 'string',
        'Id': 'string',
        'Arn': 'string',
        'TimeZone': 'string',
        'Description': 'string',
        'ValueLockLevel': 'NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
        'LockVersion': {
            'DataTable': 'string',
            'Attribute': 'string',
            'PrimaryValues': 'string',
            'Value': 'string'
        },
        'Version': 'string',
        'VersionDescription': 'string',
        'Status': 'PUBLISHED',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • DataTable (dict) –

      The complete data table information including metadata, configuration, and versioning details.

      • Name (string) –

        The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards.

      • Id (string) –

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

      • Arn (string) –

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

      • TimeZone (string) –

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

      • Description (string) –

        An optional description of the data table’s purpose and contents.

      • ValueLockLevel (string) –

        The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

      • LockVersion (dict) –

        The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.

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

      • Version (string) –

        A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).

      • VersionDescription (string) –

        A description of the customer managed version.

      • Status (string) –

        The current status of the data table. One of PUBLISHED or SAVED.

      • CreatedTime (datetime) –

        The timestamp when the data table was created.

      • LastModifiedTime (datetime) –

        The timestamp when the data table or any of its properties were last modified.

      • LastModifiedRegion (string) –

        The AWS region where the data table was last modified, used for region replication.

      • Tags (dict) –

        Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

        • (string) –

          • (string) –

Exceptions