Class DescribeQueueCommandProtected

Describe an existing queue.

Example

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

import { QueuesClient, DescribeQueueCommand } from "@stedi/sdk-client-queues"; // ES Modules import
// const { QueuesClient, DescribeQueueCommand } = require("@stedi/sdk-client-queues"); // CommonJS import
const client = new QueuesClient(config);
const input = { // DescribeQueueInput
  queueName: "STRING_VALUE", // required
};
const command = new DescribeQueueCommand(input);
const response = await client.send(command);
// { // DescribeQueueOutput
//   queueUrl: "STRING_VALUE", // required
//   approximateNumberOfMessages: Number("int"), // required
//   approximateNumberOfMessagesNotVisible: Number("int"), // required
//   approximateNumberOfMessagesDelayed: Number("int"), // required
//   queueName: "STRING_VALUE", // required
//   delaySeconds: Number("int"),
//   maximumMessageSize: Number("int"),
//   messageRetentionPeriod: Number("int"),
//   visibilityTimeout: Number("int"),
//   fifo: true || false,
//   resourceDetail: { // DescribeResourceDetail
//     status: "AVAILABLE" || "UNDER_CHANGE" || "CHANGE_FAILED" || "ERROR" || "CREATE_FAILED", // required
//     detailedStatus: "AVAILABLE_UPDATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//     statusMessage: "STRING_VALUE",
//     idempotencyKey: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     updatedAt: new Date("TIMESTAMP"), // required
//   },
// };

Param

DescribeQueueCommandInput

Returns

DescribeQueueCommandOutput

See

• DescribeQueueCommandInput for command's input shape.
• DescribeQueueCommandOutput for command's response shape.
• config for QueuesClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

ProductUnavailableException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ResourceUnderChangeException (client fault)

Throws

ServiceException (server fault)

Throws

QueuesServiceException

Base exception class for all service exceptions from Queues service.