Connect / Client / update_data_table_metadata

update_data_table_metadata

Connect.Client.update_data_table_metadata(**kwargs)

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

See also: AWS API Documentation

Request Syntax

response = client.update_data_table_metadata(
    InstanceId='string',
    DataTableId='string',
    Name='string',
    Description='string',
    ValueLockLevel='NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
    TimeZone='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 the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.

  • Name (string) –

    [REQUIRED]

    The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.

  • Description (string) – The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.

  • ValueLockLevel (string) –

    [REQUIRED]

    The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.

  • TimeZone (string) –

    [REQUIRED]

    The updated IANA timezone identifier to use when resolving time based dynamic values.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • LockVersion (dict) –

      The new lock version for the data table after the update.

      • 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