# SearchTestCases


Searches for test cases in the specified Amazon Connect instance, with optional filtering.

## Request Syntax


```
POST /search-test-cases HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "TestCaseSearchCriteria"
      ],
      "OrConditions": [ 
         "TestCaseSearchCriteria"
      ],
      "StatusCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters


The request does not use any URI parameters.

## Request Body


The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [MaxResults](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-SearchCriteria"></a>
The search criteria to be used to return test cases.  
Type: [TestCaseSearchCriteria](API_TestCaseSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [TestCaseSearchFilter](API_TestCaseSearchFilter.md) object  
Required: No

## Response Syntax


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

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "TestCases": [ 
      { 
         "Arn": "string",
         "Content": "string",
         "Description": "string",
         "EntryPoint": { 
            "ChatEntryPointParameters": { 
               "FlowId": "string"
            },
            "Type": "string",
            "VoiceCallEntryPointParameters": { 
               "DestinationPhoneNumber": "string",
               "FlowId": "string",
               "SourcePhoneNumber": "string"
            }
         },
         "Id": "string",
         "InitializationData": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TestCaseSha256": "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.

 ** [ApproximateTotalCount](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-ApproximateTotalCount"></a>
The total number of test cases which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [TestCases](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-TestCases"></a>
Information about the test cases.  
Type: Array of [TestCase](API_TestCase.md) objects

## Errors


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

 ** 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:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchTestCases)