Search Agent Statuses

connect_search_agent_statuses

R Documentation

Searches AgentStatuses in an Amazon Connect instance, with optional filtering¶

Description¶

Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

Usage¶

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

Arguments¶

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instanceId in the 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 be applied to search results.

SearchCriteria

The search criteria to be used to return agent statuses.

Value¶

A list with the following syntax:

list(
  AgentStatuses = list(
    list(
      AgentStatusARN = "string",
      AgentStatusId = "string",
      Name = "string",
      Description = "string",
      Type = "ROUTABLE"|"CUSTOM"|"OFFLINE",
      DisplayOrder = 123,
      State = "ENABLED"|"DISABLED",
      Tags = list(
        "string"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string",
  ApproximateTotalCount = 123
)

Request syntax¶

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