Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListQueuesCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { SQSClient, ListQueuesCommand } from "@aws-sdk/client-sqs"; // ES Modules import
// const { SQSClient, ListQueuesCommand } = require("@aws-sdk/client-sqs"); // CommonJS import
const client = new SQSClient(config);
const command = new ListQueuesCommand(input);
const response = await client.send(command);
see

ListQueuesCommandInput for command's input shape.

see

ListQueuesCommandOutput for command's response shape.

see

config for SQSClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: ListQueuesCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListQueuesCommandInput, ListQueuesCommandOutput>