Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchResourceTags

Searches tags used in an Amazon Connect instance using optional search criteria.

Request Syntax


POST /search-resource-tags HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceTypes": [ "string" ],
   "SearchCriteria": { 
      "TagSearchCondition": { 
         "tagKey": "string",
         "tagKeyComparisonType": "string",
         "tagValue": "string",
         "tagValueComparisonType": "string"
      }
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

InstanceId

The identifier of the Amazon Connect instance. You can find the instanceId 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

The maximum number of results to return per page.

Type: Integer

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

Required: No

NextToken

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

ResourceTypes

The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.

Supported resource types

AGENT
ROUTING_PROFILE
STANDARD_QUEUE
SECURITY_PROFILE
OPERATING_HOURS
PROMPT
CONTACT_FLOW
FLOW_MODULE

Type: Array of strings

Required: No

SearchCriteria

The search criteria to be used to return tags.

Type: ResourceTagsSearchCriteria object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": [ 
      { 
         "key": "string",
         "value": "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.

NextToken

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.

Tags

A list of tags used in the Amazon Connect instance.

Type: Array of TagSet objects

Errors

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

InternalServiceException

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

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

MaximumResultReturnedException

Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429