Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDataTableValues

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.

Request Syntax


POST /data-tables/InstanceId/DataTableId/values/list?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "PrimaryAttributeValues": [ 
      { 
         "AttributeName": "string",
         "Values": [ "string" ]
      }
   ],
   "RecordIds": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

DataTableId

The unique identifier for the data table whose values should be listed.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

InstanceId

The unique identifier for the Amazon Connect instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

The maximum number of data table values to return in one page of results.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

Request Body

The request accepts the following data in JSON format.

PrimaryAttributeValues

Optional filter to retrieve values for records matching specific primary attribute criteria.

Type: Array of PrimaryAttributeValueFilter objects

Required: No

RecordIds

Optional list of specific record IDs to retrieve values for.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Values": [ 
      { 
         "AttributeId": "string",
         "AttributeName": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeId": "string",
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string",
         "Value": "string",
         "ValueType": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

Type: String

Values

A list of data table values with their associated metadata, lock versions, and modification details.

Type: Array of DataTableValueSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429