Skip to content

Search Workspace Associations

connect_search_workspace_associations R Documentation

Searches for workspace associations with users or routing profiles based on various criteria

Description

Searches for workspace associations with users or routing profiles based on various criteria.

Usage

connect_search_workspace_associations(InstanceId, NextToken, MaxResults,
  SearchFilter, SearchCriteria)

Arguments

InstanceId

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

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.

SearchFilter

Filters to apply to the search, such as tag-based filters.

SearchCriteria

The search criteria, including workspace ID, resource ID, or resource type.

Value

A list with the following syntax:

list(
  NextToken = "string",
  WorkspaceAssociations = list(
    list(
      WorkspaceId = "string",
      WorkspaceArn = "string",
      ResourceId = "string",
      ResourceArn = "string",
      ResourceType = "string",
      ResourceName = "string"
    )
  ),
  ApproximateTotalCount = 123
)

Request syntax

svc$search_workspace_associations(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  SearchFilter = list(
    AttributeFilter = list(
      OrConditions = list(
        list(
          TagConditions = list(
            list(
              TagKey = "string",
              TagValue = "string"
            )
          )
        )
      ),
      AndCondition = list(
        TagConditions = list(
          list(
            TagKey = "string",
            TagValue = "string"
          )
        )
      ),
      TagCondition = list(
        TagKey = "string",
        TagValue = "string"
      )
    )
  ),
  SearchCriteria = list(
    OrConditions = list(
      list()
    ),
    AndConditions = list(
      list()
    ),
    StringCondition = list(
      FieldName = "string",
      Value = "string",
      ComparisonType = "STARTS_WITH"|"CONTAINS"|"EXACT"
    )
  )
)