DescribeTestExecution - Amazon Lex API Reference
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DescribeTestExecution

Gets metadata information about the test execution.

Request Syntax

GET /testexecutions/testExecutionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

testExecutionId

The execution Id of the test set execution.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "apiMode": "string",
   "creationDateTime": number,
   "failureReasons": [ "string" ],
   "lastUpdatedDateTime": number,
   "target": { 
      "botAliasTarget": { 
         "botAliasId": "string",
         "botId": "string",
         "localeId": "string"
      }
   },
   "testExecutionId": "string",
   "testExecutionModality": "string",
   "testExecutionStatus": "string",
   "testSetId": "string",
   "testSetName": "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.

apiMode

Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API is used.

Type: String

Valid Values: Streaming | NonStreaming

creationDateTime

The execution creation date and time for the test set execution.

Type: Timestamp

failureReasons

Reasons for the failure of the test set execution.

Type: Array of strings

lastUpdatedDateTime

The date and time of the last update for the execution.

Type: Timestamp

target

The target bot for the test set execution details.

Type: TestExecutionTarget object

testExecutionId

The execution Id for the test set execution.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

testExecutionModality

Indicates whether test set is audio or text.

Type: String

Valid Values: Text | Audio

testExecutionStatus

The test execution status for the test execution.

Type: String

Valid Values: Pending | Waiting | InProgress | Completed | Failed | Stopping | Stopped

testSetId

The test set Id for the test set execution.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

testSetName

The test set name of the test set execution.

Type: String

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

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Errors

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

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: