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

BatchDescribeDataTableValue

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.

Request Syntax


POST /data-tables/InstanceId/DataTableId/values/describe HTTP/1.1
Content-type: application/json

{
   "Values": [ 
      { 
         "AttributeName": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

DataTableId

The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

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

Request Body

The request accepts the following data in JSON format.

Values

A list of value identifiers to retrieve, each specifying primary values and attribute names.

Type: Array of DataTableValueIdentifier objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "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"
      }
   ]
}

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.

Failed

A list of values that failed to be retrieved with error messages explaining the failure reason.

Type: Array of BatchDescribeDataTableValueFailureResult objects

Successful

A list of successfully retrieved values with their data, metadata, and lock version information.

Type: Array of BatchDescribeDataTableValueSuccessResult 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