The action to start test set execution.
Request Syntax
POST /testsets/testSetId/testexecutions HTTP/1.1
Content-type: application/json
{
"apiMode": "string",
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionModality": "string"
}URI Request Parameters
The request uses the following URI parameters.
- testSetId
-
The test set Id for the test set execution.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- apiMode
-
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
Type: String
Valid Values:
Streaming | NonStreamingRequired: Yes
- target
-
The target bot for the test set execution.
Type: TestExecutionTarget object
Required: Yes
- testExecutionModality
-
Indicates whether audio or text is used.
Type: String
Valid Values:
Text | AudioRequired: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"apiMode": "string",
"creationDateTime": number,
"target": {
"botAliasTarget": {
"botAliasId": "string",
"botId": "string",
"localeId": "string"
}
},
"testExecutionId": "string",
"testExecutionModality": "string",
"testSetId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- apiMode
-
Indicates whether we use streaming or non-streaming APIs 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 are used.
Type: String
Valid Values:
Streaming | NonStreaming - creationDateTime
-
The creation date and time for the test set execution.
Type: Timestamp
- target
-
The target bot for the test set execution.
Type: TestExecutionTarget object
- testExecutionId
-
The unique identifier of the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - testExecutionModality
-
Indicates whether audio or text is used.
Type: String
Valid Values:
Text | Audio - testSetId
-
The test set Id for the test set execution.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
- 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:
