ListQueues
Returns a summary of each queue in the AWS account and Region used by the
request. Use StreamFilter to list only the queues on a particular data
stream.
If the response contains a NextToken, more queues are available. Call
ListQueues again with that value to retrieve the next page.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"StreamFilter": [
{
"StreamARN": "string",
"StreamCreationTimestamp": number
}
]
}
Request Parameters
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of queue summaries to return in one response. The response might contain fewer summaries than this value, and might contain a
NextTokeneven when it contains fewer.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10000.
Required: No
- NextToken
-
The
NextTokenreturned by a previousListQueuesrequest. Use it to retrieve the next page of queue summaries.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1048576.
Required: No
- StreamFilter
-
Lists only the queues created on the specified data stream.
Type: Array of QueueStreamFilter objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
Response Syntax
{
"NextToken": "string",
"QueueSummaries": [
{
"QueueARN": "string",
"QueueCreationTimestamp": number,
"QueueName": "string",
"QueueStatus": "string",
"Streams": [
{
"StreamARN": "string",
"StreamCreationTimestamp": number
}
]
}
]
}
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.
- NextToken
-
The token to pass to the next
ListQueuesrequest to retrieve the next page of queue summaries. This member is absent when no more queues are available.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1048576.
- QueueSummaries
-
A summary of each queue that matched the request.
Type: Array of QueueSummary objects
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
- ExpiredNextTokenException
-
The pagination token passed to the operation is expired.
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
- 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: