Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

update-agent-status

Description

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

Updates agent status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-agent-status
--instance-id <value>
--agent-status-id <value>
[--name <value>]
[--description <value>]
[--state <value>]
[--display-order <value>]
[--reset-order-number | --no-reset-order-number]
[--cli-input-json <value>]
[--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 of the agent status.

--name (string)

The name of the agent status.

--description (string)

The description of the agent status.

--state (string)

The state of the agent status.

Possible values:

  • ENABLED
  • DISABLED

--display-order (integer)

The display order of the agent status.

--reset-order-number | --no-reset-order-number (boolean)

A number indicating the reset order of the agent status.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

None