StartTestCaseExecution
Starts executing a published test case.
Request Syntax
PUT /test-cases/InstanceId/TestCaseId/start-execution HTTP/1.1
Content-type: application/json
{
"ClientToken": "string"
}URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- TestCaseId
-
The identifier of the test case to execute.
Length Constraints: Maximum length of 500.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Status": "string",
"TestCaseExecutionId": "string",
"TestCaseId": "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.
- Status
-
The status of a test case execution.
Type: String
Valid Values:
INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED - TestCaseExecutionId
-
The identifier of the test case execution.
Type: String
Length Constraints: Maximum length of 500.
- TestCaseId
-
The identifier of the test case resource that was executed.
Type: String
Length Constraints: Maximum length of 500.
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
- ServiceQuotaExceededException
-
The service quota has been exceeded.
- Reason
-
The reason for the exception.
HTTP Status Code: 402
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
