# StartTestCaseExecution
<a name="API_StartTestCaseExecution"></a>

Starts executing a published test case.

## Request Syntax
<a name="API_StartTestCaseExecution_RequestSyntax"></a>

```
PUT /test-cases/InstanceId/TestCaseId/start-execution HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_StartTestCaseExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TestCaseId](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-uri-TestCaseId"></a>
The identifier of the test case to execute.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_StartTestCaseExecution_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-ClientToken"></a>
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](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_StartTestCaseExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Status": "string",
   "TestCaseExecutionId": "string",
   "TestCaseId": "string"
}
```

## Response Elements
<a name="API_StartTestCaseExecution_ResponseElements"></a>

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](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-Status"></a>
The status of a test case execution.  
Type: String  
Valid Values: `INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED` 

 ** [TestCaseExecutionId](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-TestCaseExecutionId"></a>
The identifier of the test case execution.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [TestCaseId](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-TestCaseId"></a>
The identifier of the test case resource that was executed.  
Type: String  
Length Constraints: Maximum length of 500.

## Errors
<a name="API_StartTestCaseExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** 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
<a name="API_StartTestCaseExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartTestCaseExecution)