UpdateQueueStatus
This API is in preview release for Amazon Connect and is subject to change.
Updates the status of the queue.
Request Syntax
POST /queues/InstanceId
/QueueId
/status HTTP/1.1
Content-type: application/json
{
"Status": "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
- QueueId
-
The identifier for the queue.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Status
-
The status of the queue.
Type: String
Valid Values:
ENABLED | DISABLED
Required: Yes
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.
- 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
- 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: