v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

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

Updates agent status.

post/agent-status/{InstanceId}/{AgentStatusId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

AgentStatusIdstring required

The identifier of the agent status.

Request body

Namestring

The name of the agent status.

Descriptionstring

The description of the agent status.

State'ENABLED' | 'DISABLED'

The state of the agent status.

DisplayOrderinteger

The display order of the agent status.

ResetOrderNumberboolean

A number indicating the reset order of the agent status.

Response

Success