This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
Request Syntax
PUT /agent-status/InstanceId HTTP/1.1
Content-type: application/json
{
"Description": "string",
"DisplayOrder": number,
"Name": "string",
"State": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- 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 status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No
- DisplayOrder
-
The display order of the status.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- Name
-
The name of the status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Required: Yes
- State
-
The state of the status.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: Yes
- Tags
-
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AgentStatusARN": "string",
"AgentStatusId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AgentStatusARN
-
The Amazon Resource Name (ARN) of the agent status.
Type: String
- AgentStatusId
-
The identifier of the agent status.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
