| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SQS.ListQueues
Description
Returns a list of your queues in the current region. The response
includes a maximum of 1,000 results. If you specify a value for the
optional QueueNamePrefix parameter, only queues with a name that
begins with the specified value are returned.
The listQueues methods supports pagination. Set parameter MaxResults
in the request to specify the maximum number of results to be returned
in the response. If you do not set MaxResults, the response includes a
maximum of 1,000 results. If you set MaxResults and there are
additional results to display, the response includes a value for
NextToken. Use NextToken as a parameter in your next request to
listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
This operation returns paginated results.
Synopsis
- data ListQueues = ListQueues' {
- queueNamePrefix :: Maybe Text
- nextToken :: Maybe Text
- maxResults :: Maybe Int
- newListQueues :: ListQueues
- listQueues_queueNamePrefix :: Lens' ListQueues (Maybe Text)
- listQueues_nextToken :: Lens' ListQueues (Maybe Text)
- listQueues_maxResults :: Lens' ListQueues (Maybe Int)
- data ListQueuesResponse = ListQueuesResponse' {}
- newListQueuesResponse :: Int -> ListQueuesResponse
- listQueuesResponse_queueUrls :: Lens' ListQueuesResponse (Maybe [Text])
- listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text)
- listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int
Creating a Request
data ListQueues Source #
See: newListQueues smart constructor.
Constructors
| ListQueues' | |
Fields
| |
Instances
newListQueues :: ListQueues Source #
Create a value of ListQueues with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queueNamePrefix:ListQueues', listQueues_queueNamePrefix - A string to use for filtering the list results. Only those queues whose
name begins with the specified string are returned.
Queue URLs and names are case-sensitive.
$sel:nextToken:ListQueues', listQueues_nextToken - Pagination token to request the next set of results.
$sel:maxResults:ListQueues', listQueues_maxResults - Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults to receive a value for NextToken in
the response.
Request Lenses
listQueues_queueNamePrefix :: Lens' ListQueues (Maybe Text) Source #
A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
Queue URLs and names are case-sensitive.
listQueues_nextToken :: Lens' ListQueues (Maybe Text) Source #
Pagination token to request the next set of results.
listQueues_maxResults :: Lens' ListQueues (Maybe Int) Source #
Maximum number of results to include in the response. Value range is 1
to 1000. You must set MaxResults to receive a value for NextToken in
the response.
Destructuring the Response
data ListQueuesResponse Source #
A list of your queues.
See: newListQueuesResponse smart constructor.
Constructors
| ListQueuesResponse' | |
Fields
| |
Instances
newListQueuesResponse Source #
Arguments
| :: Int | |
| -> ListQueuesResponse |
Create a value of ListQueuesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queueUrls:ListQueuesResponse', listQueuesResponse_queueUrls - A list of queue URLs, up to 1,000 entries, or the value of MaxResults
that you sent in the request.
$sel:nextToken:ListQueues', listQueuesResponse_nextToken - Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults in the request.
$sel:httpStatus:ListQueuesResponse', listQueuesResponse_httpStatus - The response's http status code.
Response Lenses
listQueuesResponse_queueUrls :: Lens' ListQueuesResponse (Maybe [Text]) Source #
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text) Source #
Pagination token to include in the next request. Token value is null
if there are no additional results to request, or if you did not set
MaxResults in the request.
listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int Source #
The response's http status code.