DescribeQueue
Returns a description of the specified queue, including its status, the data stream it delivers records from, and its configuration attributes.
Request Syntax
{
"QueueARN": "string"
}
Request Parameters
The request accepts the following data in JSON format.
- QueueARN
-
The ARN of the queue to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:aws.*:kinesis:.*:\d{12}:queue/\S+Required: Yes
Response Syntax
{
"QueueDescription": {
"QueueARN": "string",
"QueueAttributes": {
"DeadLetterConfiguration": {
"MaxReceiveCount": number,
"TargetType": "string"
},
"VisibilityTimeoutSeconds": number
},
"QueueCreationTimestamp": number,
"QueueName": "string",
"QueueStatus": "string",
"StreamConfigurationList": [
{
"StartingPosition": {
"Timestamp": number,
"Type": "string"
},
"StreamARN": "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.
- QueueDescription
-
A description of the queue.
Type: QueueDescription object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
Specifies that you do not have the permissions required to perform this operation.
HTTP Status Code: 400
- InternalFailureException
-
The processing of the request failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidArgumentException
-
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource could not be found. The stream might not be specified correctly.
- message
-
A message that provides information about the error.
HTTP Status Code: 400
- ValidationException
-
The request failed validation. For example, a parameter value is not valid, a combination of parameters is not supported, or the operation is not supported for the stream's capacity mode. The error message describes the specific reason.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: