Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAgentStatus

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

Updates agent status.

Request Syntax


POST /agent-status/InstanceId/AgentStatusId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayOrder": number,
   "Name": "string",
   "ResetOrderNumber": boolean,
   "State": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AgentStatusId

The identifier of the agent status.

Required: Yes

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the agent status.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 250.

Required: No

DisplayOrder

The display order of the agent status.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

Name

The name of the agent status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 127.

Required: No

ResetOrderNumber

A number indicating the reset order of the agent status.

Type: Boolean

Required: No

State

The state of the agent status.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429