Describe Agent Status

connect_describe_agent_status

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.

Describes an agent status.

Usage¶

connect_describe_agent_status(InstanceId, AgentStatusId)

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.
AgentStatusId: [required] The identifier for the agent status.

Value¶

A list with the following syntax:

list(
  AgentStatus = 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"
  )
)

Request syntax¶

svc$describe_agent_status(
  InstanceId = "string",
  AgentStatusId = "string"
)