data_tables

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

Overview

Name	data_tables
Type	Resource
Id	aws.connect.data_tables

Fields

The following fields are returned by SELECT queries:

describe_data_table

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
created_time	string (date-time)	The timestamp when the data table was created.
description	string	An optional description of the data table's purpose and contents. (pattern: <code>^[\P{C}\r\n\t]+$</code>)
id	string	The unique identifier for the data table. Does not include version aliases.
last_modified_region	string	The Amazon Web Services Region where the data table 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 the data table or any of its properties were last modified.
lock_version	object	The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.
name	string	The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'|]+$</code>)
status	string	The current status of the data table. One of PUBLISHED or SAVED. (PUBLISHED)
tags	object	Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
time_zone	string	The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.
value_lock_level	string	The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously. (NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE)
version	string	A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
version_description	string	A description of the customer managed version. (pattern: <code>^[\P{C}\r\n\t]+$</code>)

list_data_tables

Name	Datatype	Description
arn	string	The summary's ARN.
id	string	The summary's ID.
last_modified_region	string	The summary's last modified region. (pattern: <code>[a-z]{2}(-[a-z]+){1,2}(-[0-9])?</code>)
last_modified_time	string (date-time)	The summary's last modified time.
name	string	The summary's name. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'|]+$</code>)

search_data_tables

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
created_time	string (date-time)	The timestamp when the data table was created.
description	string	An optional description of the data table's purpose and contents. (pattern: <code>^[\P{C}\r\n\t]+$</code>)
id	string	The unique identifier for the data table. Does not include version aliases.
last_modified_region	string	The Amazon Web Services Region where the data table 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 the data table or any of its properties were last modified.
lock_version	object	The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.
name	string	The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'|]+$</code>)
status	string	The current status of the data table. One of PUBLISHED or SAVED. (PUBLISHED)
tags	object	Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
time_zone	string	The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.
value_lock_level	string	The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously. (NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE)
version	string	A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
version_description	string	A description of the customer managed version. (pattern: <code>^[\P{C}\r\n\t]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_table	select	instance_id, data_table_id, region		Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
list_data_tables	select	instance_id, region	nextToken, maxResults	Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
search_data_tables	select	region		Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.
create_data_table	insert	instance_id, region, TimeZone, ValueLockLevel		Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.
update_data_table_metadata	update	instance_id, data_table_id, region, ValueLockLevel, TimeZone		Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
delete_data_table	delete	instance_id, data_table_id, region		Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.
batch_create_data_table_value	exec	instance_id, data_table_id, region, Values		Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.
batch_delete_data_table_value	exec	instance_id, data_table_id, region, Values		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.
batch_describe_data_table_value	exec	instance_id, data_table_id, region, Values		Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
batch_update_data_table_value	exec	instance_id, data_table_id, region, Values		Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.

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
data_table_id	string	The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
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 tables 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

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

SELECT
arn,
created_time,
description,
id,
last_modified_region,
last_modified_time,
lock_version,
name,
status,
tags,
time_zone,
value_lock_level,
version,
version_description
FROM aws.connect.data_tables
WHERE instance_id = '{{ instance_id }}' -- required
AND data_table_id = '{{ data_table_id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_tables

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

SELECT
arn,
id,
last_modified_region,
last_modified_time,
name
FROM aws.connect.data_tables
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

search_data_tables

Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.

SELECT
arn,
created_time,
description,
id,
last_modified_region,
last_modified_time,
lock_version,
name,
status,
tags,
time_zone,
value_lock_level,
version,
version_description
FROM aws.connect.data_tables
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_table

Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.

INSERT INTO aws.connect.data_tables (
Name,
Description,
TimeZone,
ValueLockLevel,
Status,
Tags,
instance_id,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ TimeZone }}' /* required */,
'{{ ValueLockLevel }}' /* required */,
'{{ Status }}',
'{{ Tags }}',
'{{ instance_id }}',
'{{ region }}'
RETURNING
arn,
id,
lock_version
;

Manifest

# Description fields are for documentation purposes
- name: data_tables
props:
  - name: instance_id
    value: "{{ instance_id }}"
    description: Required parameter for the data_tables resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_tables resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: TimeZone
    value: "{{ TimeZone }}"
  - name: ValueLockLevel
    value: "{{ ValueLockLevel }}"
    valid_values: ['NONE', 'DATA_TABLE', 'PRIMARY_VALUE', 'ATTRIBUTE', 'VALUE']
  - name: Status
    value: "{{ Status }}"
    valid_values: ['PUBLISHED']
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_data_table_metadata

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

UPDATE aws.connect.data_tables
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
ValueLockLevel = '{{ ValueLockLevel }}',
TimeZone = '{{ TimeZone }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND data_table_id = '{{ data_table_id }}' --required
AND region = '{{ region }}' --required
AND ValueLockLevel = '{{ ValueLockLevel }}' --required
AND TimeZone = '{{ TimeZone }}' --required
RETURNING
lock_version;

DELETE examples

delete_data_table

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

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

Lifecycle Methods

batch_create_data_table_value

Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.

EXEC aws.connect.data_tables.batch_create_data_table_value 
@instance_id='{{ instance_id }}' --required, 
@data_table_id='{{ data_table_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Values": "{{ Values }}"
}'
;

batch_delete_data_table_value

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.

EXEC aws.connect.data_tables.batch_delete_data_table_value 
@instance_id='{{ instance_id }}' --required, 
@data_table_id='{{ data_table_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Values": "{{ Values }}"
}'
;

batch_describe_data_table_value

Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

EXEC aws.connect.data_tables.batch_describe_data_table_value 
@instance_id='{{ instance_id }}' --required, 
@data_table_id='{{ data_table_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Values": "{{ Values }}"
}'
;

batch_update_data_table_value

Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.

EXEC aws.connect.data_tables.batch_update_data_table_value 
@instance_id='{{ instance_id }}' --required, 
@data_table_id='{{ data_table_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Values": "{{ Values }}"
}'
;