Skip to content

List Agent Statuses

connect_list_agent_statuses R Documentation

This API is in preview release for Amazon Connect and is subject to change

Description

This API is in preview release for Amazon Connect and is subject to change.

Lists agent statuses.

Usage

connect_list_agent_statuses(InstanceId, NextToken, MaxResults,
  AgentStatusTypes)

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.

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"
  )
)