Skip to content

Lists agent statuses

Description

Lists agent statuses.

Usage

connect_list_agent_statuses(InstanceId, NextToken, MaxResults,
  AgentStatusTypes)

Arguments

  • InstanceId

    [required] The identifier of the Connect Customer 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.

  • AgentStatusTypes

    Available agent status types.

Value

A list with the following syntax:

list(
  NextToken = "string",
  AgentStatusSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      Type = "ROUTABLE"|"CUSTOM"|"OFFLINE",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  )
)

Request syntax

svc$list_agent_statuses(
  InstanceId = "string",
  NextToken = "string",
  MaxResults = 123,
  AgentStatusTypes = list(
    "ROUTABLE"|"CUSTOM"|"OFFLINE"
  )
)