data_table_attributes

Creates, updates, deletes, gets or lists a data_table_attributes resource.

Overview

Name	`data_table_attributes`
Type	Resource
Id	`aws.connect.data_table_attributes`

Fields

The following fields are returned by SELECT queries:

describe_data_table_attribute
list_data_table_attributes

Name	Datatype	Description
`attribute_id`	`string`	The unique identifier for the attribute within the data table.
`data_table_arn`	`string`	The Amazon Resource Name (ARN) of the data table that contains this attribute.
`data_table_id`	`string`	The unique identifier of the data table that contains this attribute.
`description`	`string`	An optional description explaining the purpose and usage of this attribute. (pattern: <code>^[\P{C}\r\n\t]+$</code>)
`last_modified_region`	`string`	The Amazon Web Services Region where this attribute was last modified, used for region replication. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
`last_modified_time`	`string (date-time)`	The timestamp when this attribute was last modified.
`lock_version`	`object`	The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
`name`	`string`	The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'\|]+$</code>)
`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.
`validation`	`object`	Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.
`value_type`	`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. (TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST)
`version`	`string`	The version identifier for this attribute, used for versioning and change tracking.

Name	Datatype	Description
`attribute_id`	`string`	The unique identifier for the attribute within the data table.
`data_table_arn`	`string`	The Amazon Resource Name (ARN) of the data table that contains this attribute.
`data_table_id`	`string`	The unique identifier of the data table that contains this attribute.
`description`	`string`	An optional description explaining the purpose and usage of this attribute. (pattern: <code>^[\P{C}\r\n\t]+$</code>)
`last_modified_region`	`string`	The Amazon Web Services Region where this attribute was last modified, used for region replication. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
`last_modified_time`	`string (date-time)`	The timestamp when this attribute was last modified.
`lock_version`	`object`	The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
`name`	`string`	The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'\|]+$</code>)
`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.
`validation`	`object`	Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.
`value_type`	`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. (TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST)
`version`	`string`	The version identifier for this attribute, used for versioning and change tracking.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_data_table_attribute`	`select`	`instance_id`, `data_table_id`, `attribute_name`, `region`		Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
`list_data_table_attributes`	`select`	`instance_id`, `data_table_id`, `region`	`nextToken`, `maxResults`	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 Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.
`create_data_table_attribute`	`insert`	`instance_id`, `data_table_id`, `region`, `ValueType`		Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.
`update_data_table_attribute`	`update`	`instance_id`, `data_table_id`, `attribute_name`, `region`, `ValueType`		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.
`delete_data_table_attribute`	`delete`	`instance_id`, `data_table_id`, `attribute_name`, `region`		Deletes an attribute and all its values from a data table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`attribute_name`	`string`	The name of the attribute to delete.
`data_table_id`	`string`	The unique identifier for the data table.
`instance_id`	`string`	The unique identifier for the Amazon Connect instance.
`region`	`string`	AWS region (default: us-east-1)
`maxResults`	`integer`	The maximum number of data table attributes to return in one page of results.
`nextToken`	`string`	Specify the pagination token from a previous request to retrieve the next page of results.

`SELECT` examples

describe_data_table_attribute
list_data_table_attributes

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

SELECT
attribute_id,
data_table_arn,
data_table_id,
description,
last_modified_region,
last_modified_time,
lock_version,
name,
primary,
validation,
value_type,
version
FROM aws.connect.data_table_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND data_table_id = '{{ data_table_id }}' -- required
AND attribute_name = '{{ attribute_name }}' -- required
AND region = '{{ region }}' -- required
;

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 Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

SELECT
attribute_id,
data_table_arn,
data_table_id,
description,
last_modified_region,
last_modified_time,
lock_version,
name,
primary,
validation,
value_type,
version
FROM aws.connect.data_table_attributes
WHERE instance_id = '{{ instance_id }}' -- required
AND data_table_id = '{{ data_table_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

`INSERT` examples

create_data_table_attribute
Manifest

Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.

INSERT INTO aws.connect.data_table_attributes (
Name,
ValueType,
Description,
Primary,
Validation,
instance_id,
data_table_id,
region
)
SELECT 
'{{ Name }}',
'{{ ValueType }}' /* required */,
'{{ Description }}',
{{ Primary }},
'{{ Validation }}',
'{{ instance_id }}',
'{{ data_table_id }}',
'{{ region }}'
RETURNING
attribute_id,
lock_version,
name
;

# Description fields are for documentation purposes
- name: data_table_attributes
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the data_table_attributes resource.
  - name: data_table_id
    value: "{{ data_table_id }}"
    description: Required parameter for the data_table_attributes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_table_attributes resource.
  - name: Name
    value: "{{ Name }}"
  - name: ValueType
    value: "{{ ValueType }}"
    valid_values: ['TEXT', 'NUMBER', 'BOOLEAN', 'TEXT_LIST', 'NUMBER_LIST']
  - name: Description
    value: "{{ Description }}"
  - name: Primary
    value: {{ Primary }}
  - name: Validation
    description: |
      Defines validation rules for data table attribute values. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations. Validation rules ensure data integrity and consistency across the data table.
    value:
      MinLength: {{ MinLength }}
      MaxLength: {{ MaxLength }}
      MinValues: {{ MinValues }}
      MaxValues: {{ MaxValues }}
      IgnoreCase: {{ IgnoreCase }}
      Minimum: {{ Minimum }}
      Maximum: {{ Maximum }}
      ExclusiveMinimum: {{ ExclusiveMinimum }}
      ExclusiveMaximum: {{ ExclusiveMaximum }}
      MultipleOf: {{ MultipleOf }}
      Enum:
        Strict: {{ Strict }}
        Values:
          - "{{ Values }}"

`UPDATE` examples

update_data_table_attribute

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.

UPDATE aws.connect.data_table_attributes
SET 
Name = '{{ Name }}',
ValueType = '{{ ValueType }}',
Description = '{{ Description }}',
Primary = {{ Primary }},
Validation = '{{ Validation }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND data_table_id = '{{ data_table_id }}' --required
AND attribute_name = '{{ attribute_name }}' --required
AND region = '{{ region }}' --required
AND ValueType = '{{ ValueType }}' --required
RETURNING
lock_version,
name;

`DELETE` examples

delete_data_table_attribute

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

DELETE FROM aws.connect.data_table_attributes
WHERE instance_id = '{{ instance_id }}' --required
AND data_table_id = '{{ data_table_id }}' --required
AND attribute_name = '{{ attribute_name }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​