Skip to content

Search Resource Tags

connect_search_resource_tags R Documentation

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

Description

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

Usage

connect_search_resource_tags(InstanceId, ResourceTypes, NextToken,
  MaxResults, SearchCriteria)

Arguments

InstanceId

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

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. Note that lowercase and - are required.

Supported resource types

  • agent

  • agent-state

  • routing-profile

  • standard-queue

  • security-profile

  • operating-hours

  • prompt

  • contact-flow

  • flow- module

  • transfer-destination (also known as quick connect)

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.

MaxResults

The maximum number of results to return per page.

SearchCriteria

The search criteria to be used to return tags.

Value

A list with the following syntax: 

list(
  Tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$search_resource_tags(
  InstanceId = "string",
  ResourceTypes = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  SearchCriteria = list(
    TagSearchCondition = list(
      tagKey = "string",
      tagValue = "string",
      tagKeyComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT",
      tagValueComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    )
  )
)