SearchRoutingProfiles - Amazon Connect


This API is in preview release for Amazon Connect and is subject to change.

Searches routing profiles in an Amazon Connect instance, with optional filtering.

Request Syntax

POST /search-routing-profiles HTTP/1.1 Content-type: application/json { "InstanceId": "string", "MaxResults": number, "NextToken": "string", "SearchCriteria": { "AndConditions": [ "RoutingProfileSearchCriteria" ], "OrConditions": [ "RoutingProfileSearchCriteria" ], "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.


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


The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No


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


The search criteria to be used to return routing profiles.


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 throw invalid results.

Type: RoutingProfileSearchCriteria object

Required: No


Filters to be applied to search results.

Type: RoutingProfileSearchFilter object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApproximateTotalCount": number, "NextToken": "string", "RoutingProfiles": [ { "DefaultOutboundQueueId": "string", "Description": "string", "InstanceId": "string", "MediaConcurrencies": [ { "Channel": "string", "Concurrency": number, "CrossChannelBehavior": { "BehaviorType": "string" } } ], "Name": "string", "NumberOfAssociatedQueues": number, "NumberOfAssociatedUsers": number, "RoutingProfileArn": "string", "RoutingProfileId": "string", "Tags": { "string" : "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.


The total number of routing profiles which matched your search query.

Type: Long


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.


Information about the routing profiles.

Type: Array of RoutingProfile objects


For information about the errors that are common to all actions, see Common Errors.


Request processing failed because of an error or failure with the service.

HTTP Status Code: 500


One or more of the specified parameters are not valid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource was not found.

HTTP Status Code: 404


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: