Sign in

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.

Creates an agent status for the specified Amazon Connect instance.

put/agent-status/{InstanceId}

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.

Request body

Namestring required

The name of the status.

Descriptionstring

The description of the status.

State'ENABLED' | 'DISABLED' required

The state of the status.

DisplayOrderinteger

The display order of the status.

Tagsobject

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Response

Success

AgentStatusARNstring

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

AgentStatusIdstring

The identifier of the agent status.