Search Workspaces

connect_search_workspaces

R Documentation

Searches workspaces based on name, description, visibility, or tags¶

Description¶

Searches workspaces based on name, description, visibility, or tags.

Usage¶

connect_search_workspaces(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.

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

SearchCriteria

The search criteria, including field names and comparison types.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Workspaces = list(
    list(
      Id = "string",
      Name = "string",
      Visibility = "ALL"|"ASSIGNED"|"NONE",
      Description = "string",
      Title = "string",
      Arn = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        "string"
      )
    )
  ),
  ApproximateTotalCount = 123
)

Request syntax¶

svc$search_workspaces(
  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"
    )
  )
)