Connect / Client / update_data_table_attribute

update_data_table_attribute

Connect.Client.update_data_table_attribute(**kwargs)

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute’s validation does not invalidate existing values since validation only runs when values are created or updated.

See also: AWS API Documentation

Request Syntax

response = client.update_data_table_attribute(
    InstanceId='string',
    DataTableId='string',
    AttributeName='string',
    Name='string',
    ValueType='TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
    Description='string',
    Primary=True|False,
    Validation={
        'MinLength': 123,
        'MaxLength': 123,
        'MinValues': 123,
        'MaxValues': 123,
        'IgnoreCase': True|False,
        'Minimum': 123.0,
        'Maximum': 123.0,
        'ExclusiveMinimum': 123.0,
        'ExclusiveMaximum': 123.0,
        'MultipleOf': 123.0,
        'Enum': {
            'Strict': True|False,
            'Values': [
                '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.

  • AttributeName (string) –

    [REQUIRED]

    The current name of the attribute to update. Used as an identifier since attribute names can be changed.

  • Name (string) –

    [REQUIRED]

    The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.

  • ValueType (string) –

    [REQUIRED]

    The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.

  • Description (string) – The updated description for the attribute.

  • Primary (boolean) – Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.

  • Validation (dict) –

    The updated validation rules for the attribute. Changes do not affect existing values until they are modified.

    • MinLength (integer) –

      The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.

    • MaxLength (integer) –

      The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.

    • MinValues (integer) –

      The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.

    • MaxValues (integer) –

      The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.

    • IgnoreCase (boolean) –

      Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.

    • Minimum (float) –

      The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.

    • Maximum (float) –

      The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.

    • ExclusiveMinimum (float) –

      The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.

    • ExclusiveMaximum (float) –

      The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.

    • MultipleOf (float) –

      Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.

    • Enum (dict) –

      Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.

      • Strict (boolean) –

        Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.

      • Values (list) –

        A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.

        • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Name (string) –

      The trimmed name and identifier for the updated attribute.

    • LockVersion (dict) –

      The new lock version for the attribute 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