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

EvaluateDataTableValues

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: AWS API Standards.

Request Syntax


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

{
   "TimeZone": "string",
   "Values": [ 
      { 
         "AttributeNames": [ "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

MaxResults

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

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

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.

TimeZone

Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.

Type: String

Required: No

Values

A list of value evaluation sets specifying which primary values and attributes to evaluate.

Type: Array of DataTableValueEvaluationSet objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Values": [ 
      { 
         "AttributeName": "string",
         "Error": boolean,
         "EvaluatedValue": "string",
         "Found": boolean,
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "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 evaluated values with their computed results, error information, and metadata.

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