Connect / Client / batch_delete_data_table_value

batch_delete_data_table_value

Connect.Client.batch_delete_data_table_value(**kwargs)

Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_data_table_value(
    InstanceId='string',
    DataTableId='string',
    Values=[
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': '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.

  • Values (list) –

    [REQUIRED]

    A list of value identifiers to delete, each specifying primary values, attribute name, and lock version information.

    • (dict) –

      A data table delete value identifier.

      • PrimaryValues (list) –

        The identifier’s primary values.

        • (dict) –

          Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.

          • AttributeName (string) – [REQUIRED]

            The name of the primary attribute that this value belongs to.

          • Value (string) – [REQUIRED]

            The actual value for the primary attribute. Must be provided as a string regardless of the attribute’s value type. Primary values cannot be expressions and must be explicitly specified.

      • AttributeName (string) – [REQUIRED]

        The identifier’s attribute name.

      • LockVersion (dict) – [REQUIRED]

        The identifier’s lock version.

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

Return type:

dict

Returns:

Response Syntax

{
    'Successful': [
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': 'string'
            }
        },
    ],
    'Failed': [
        {
            'PrimaryValues': [
                {
                    'AttributeName': 'string',
                    'Value': 'string'
                },
            ],
            'AttributeName': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Successful (list) –

      A list of successfully deleted values with their identifiers and updated lock versions.

      • (dict) –

        A batch delete data table value success result.

        • PrimaryValues (list) –

          The result’s primary values.

          • (dict) –

            Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.

            • AttributeName (string) –

              The name of the primary attribute that this value belongs to.

            • Value (string) –

              The actual value for the primary attribute. Must be provided as a string regardless of the attribute’s value type. Primary values cannot be expressions and must be explicitly specified.

        • AttributeName (string) –

          The result’s attribute name.

        • LockVersion (dict) –

          The result’s lock version.

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

    • Failed (list) –

      A list of values that failed to be deleted with error messages explaining the failure reason.

      • (dict) –

        A batch delete data table value failure result.

        • PrimaryValues (list) –

          The result’s primary values.

          • (dict) –

            Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.

            • AttributeName (string) –

              The name of the primary attribute that this value belongs to.

            • Value (string) –

              The actual value for the primary attribute. Must be provided as a string regardless of the attribute’s value type. Primary values cannot be expressions and must be explicitly specified.

        • AttributeName (string) –

          The result’s attribute name.

        • Message (string) –

          The result’s message.

Exceptions