Connect / Client / list_data_table_attributes

list_data_table_attributes¶

Connect.Client.list_data_table_attributes(**kwargs)¶

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using AWS Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

Request Syntax

response = client.list_data_table_attributes(
    InstanceId='string',
    DataTableId='string',
    AttributeIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

InstanceId (string) –
[REQUIRED]

The unique identifier for the Amazon Connect instance.
DataTableId (string) –
[REQUIRED]

The unique identifier for the data table whose attributes should be listed.
AttributeIds (list) –
Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.
- (string) –
NextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults (integer) – The maximum number of data table attributes to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Attributes': [
        {
            'AttributeId': 'string',
            'Name': 'string',
            'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
            'Description': 'string',
            'DataTableId': 'string',
            'DataTableArn': 'string',
            'Primary': True|False,
            'Version': 'string',
            'LockVersion': {
                'DataTable': 'string',
                'Attribute': 'string',
                'PrimaryValues': 'string',
                'Value': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedRegion': 'string',
            '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',
                    ]
                }
            }
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  Specify the pagination token from a previous request to retrieve the next page of results.
- Attributes (list) –
  
  A list of data table attributes with their complete configuration and metadata.
  - (dict) –
    
    Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.
    - AttributeId (string) –
      
      The unique identifier for the attribute within the data table.
    - Name (string) –
      
      The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.
    - ValueType (string) –
      
      The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.
    - Description (string) –
      
      An optional description explaining the purpose and usage of this attribute.
    - DataTableId (string) –
      
      The unique identifier of the data table that contains this attribute.
    - DataTableArn (string) –
      
      The Amazon Resource Name (ARN) of the data table that contains this attribute.
    - Primary (boolean) –
      
      Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.
    - Version (string) –
      
      The version identifier for this attribute, used for versioning and change tracking.
    - LockVersion (dict) –
      
      The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
      - 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.
    - LastModifiedTime (datetime) –
      
      The timestamp when this attribute was last modified.
    - LastModifiedRegion (string) –
      
      The AWS region where this attribute was last modified, used for region replication.
    - Validation (dict) –
      
      The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.
      - 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) –

list_data_table_attributes¶

Request Syntax

Response Syntax

Response Structure

Exceptions