Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

search-resource-tags¶

Description¶

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

Synopsis¶

  search-resource-tags
--instance-id <value>
[--resource-types <value>]
[--search-criteria <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.

--resource-types (list)

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

(string)

Syntax:

"string" "string" ...

--search-criteria (structure)

The search criteria to be used to return tags.

TagSearchCondition -> (structure)

The search criteria to be used to return tags.

tagKey -> (string)

The tag key used in the tag search condition.

tagValue -> (string)

The tag value used in the tag search condition.

tagKeyComparisonType -> (string)

The type of comparison to be made when evaluating the tag key in tag search condition.

tagValueComparisonType -> (string)

The type of comparison to be made when evaluating the tag value in tag search condition.

Shorthand Syntax:

TagSearchCondition={tagKey=string,tagValue=string,tagKeyComparisonType=string,tagValueComparisonType=string}

JSON Syntax:

{
  "TagSearchCondition": {
    "tagKey": "string",
    "tagValue": "string",
    "tagKeyComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT",
    "tagValueComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

Tags -> (list)

A list of tags used in the Amazon Connect instance.

(structure)

A tag set contains tag key and tag value.

key -> (string)

The tag key in the tagSet.

value -> (string)

The tag value in the tagSet.

NextToken -> (string)

If there are additional results, this is the token for the next set of results.

Table Of Contents

Feedback

User Guide