[ aws . connect ]

describe-agent-status

Description

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

Describes an agent status.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-agent-status
--instance-id <value>
--agent-status-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--agent-status-id (string)

The identifier for the agent status.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AgentStatus -> (structure)

The agent status.

AgentStatusARN -> (string)

The Amazon Resource Name (ARN) of the agent status.

AgentStatusId -> (string)

The identifier of the agent status.

Name -> (string)

The name of the agent status.

Description -> (string)

The description of the agent status.

Type -> (string)

The type of agent status.

DisplayOrder -> (integer)

The display order of the agent status.

State -> (string)

The state of the agent status.

Tags -> (map)

One or more tags.

key -> (string)

value -> (string)