Connect / Client / delete_data_table_attribute

delete_data_table_attribute

Connect.Client.delete_data_table_attribute(**kwargs)

Deletes an attribute and all its values from a data table.

See also: AWS API Documentation

Request Syntax

response = client.delete_data_table_attribute(
    InstanceId='string',
    DataTableId='string',
    AttributeName='string'
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The unique identifier for the Amazon Connect instance.

• DataTableId (string) –

  [REQUIRED]

  The unique identifier for the data table.

• AttributeName (string) –

  [REQUIRED]

  The name of the attribute to delete.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • LockVersion (dict) –

    The updated lock version of the data table.

    • 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

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.ConflictException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.InvalidParameterException