data_table_values

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

Overview

Name	data_table_values
Type	Resource
Id	aws.connect.data_table_values

Fields

The following fields are returned by SELECT queries:

list_data_table_values

Name	Datatype	Description
attribute_id	string	The summary's attribute ID.
attribute_name	string	The summary's attribute name. (pattern: <code>^[\p{L}\p{Z}\p{N}-_.:=@'|]+$</code>)
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.
lock_version	object	The summary's lock version.
primary_values	array	The summary's primary values.
record_id	string	The summary's record ID.
value	string	The summary's value.
value_type	string	The summary's value type. (TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_data_table_values	select	instance_id, data_table_id, region	nextToken, maxResults	Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.
evaluate_data_table_values	exec	instance_id, data_table_id, region	nextToken, maxResults	Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

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 table values 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

list_data_table_values

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

SELECT
attribute_id,
attribute_name,
last_modified_region,
last_modified_time,
lock_version,
primary_values,
record_id,
value,
value_type
FROM aws.connect.data_table_values
WHERE instance_id = '{{ instance_id }}' -- required
AND data_table_id = '{{ data_table_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

Lifecycle Methods

evaluate_data_table_values

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

EXEC aws.connect.data_table_values.evaluate_data_table_values 
@instance_id='{{ instance_id }}' --required, 
@data_table_id='{{ data_table_id }}' --required, 
@region='{{ region }}' --required, 
@nextToken='{{ nextToken }}', 
@maxResults='{{ maxResults }}' 
@@json=
'{
"Values": "{{ Values }}", 
"TimeZone": "{{ TimeZone }}"
}'
;