# SearchContactFlows
<a name="API_SearchContactFlows"></a>

Searches the flows in an Amazon Connect instance, with optional filtering.

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

```
POST /search-contact-flows HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "ContactFlowSearchCriteria"
      ],
      "OrConditions": [ 
         "ContactFlowSearchCriteria"
      ],
      "StateCondition": "string",
      "StatusCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      },
      "TypeCondition": "string"
   },
   "SearchFilter": { 
      "FlowAttributeFilter": { 
         "AndCondition": { 
            "ContactFlowTypeCondition": { 
               "ContactFlowType": "string"
            },
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "ContactFlowTypeCondition": { 
            "ContactFlowType": "string"
         },
         "OrConditions": [ 
            { 
               "ContactFlowTypeCondition": { 
                  "ContactFlowType": "string"
               },
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      },
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-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 100.  
Required: Yes

 ** [MaxResults](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-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_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-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_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-SearchCriteria"></a>
The search criteria to be used to return flows.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Type: [ContactFlowSearchCriteria](API_ContactFlowSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [ContactFlowSearchFilter](API_ContactFlowSearchFilter.md) object  
Required: No

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

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

{
   "ApproximateTotalCount": number,
   "ContactFlows": [ 
      { 
         "Arn": "string",
         "Content": "string",
         "Description": "string",
         "FlowContentSha256": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "State": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string",
         "Version": number,
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchContactFlows_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.

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

 ** [ContactFlows](#API_SearchContactFlows_ResponseSyntax) **   <a name="connect-SearchContactFlows-response-ContactFlows"></a>
Information about the flows.  
Type: Array of [ContactFlow](API_ContactFlow.md) objects

 ** [NextToken](#API_SearchContactFlows_ResponseSyntax) **   <a name="connect-SearchContactFlows-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.

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

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

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