Connect / Client / update_data_table_primary_values

update_data_table_primary_values

Connect.Client.update_data_table_primary_values(**kwargs)

Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.

See also: AWS API Documentation

Request Syntax

response = client.update_data_table_primary_values(
    InstanceId='string',
    DataTableId='string',
    PrimaryValues=[
        {
            'AttributeName': 'string',
            'Value': 'string'
        },
    ],
    NewPrimaryValues=[
        {
            'AttributeName': 'string',
            'Value': '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. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.

  • PrimaryValues (list) –

    [REQUIRED]

    The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.

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

  • NewPrimaryValues (list) –

    [REQUIRED]

    The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.

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

  • LockVersion (dict) –

    [REQUIRED]

    The lock version information required for optimistic locking to prevent concurrent modifications.

    • 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

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

Response Structure

  • (dict) –

    • LockVersion (dict) –

      The updated lock version information for the data table and affected components after the primary values change.

      • 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