- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListConfigurationsCommand
Returns a list of all configurations.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MqClient, ListConfigurationsCommand } from "@aws-sdk/client-mq"; // ES Modules import
// const { MqClient, ListConfigurationsCommand } = require("@aws-sdk/client-mq"); // CommonJS import
const client = new MqClient(config);
const input = { // ListConfigurationsRequest
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new ListConfigurationsCommand(input);
const response = await client.send(command);
// { // ListConfigurationsResponse
// Configurations: [ // __listOfConfiguration
// { // Configuration
// Arn: "STRING_VALUE", // required
// AuthenticationStrategy: "SIMPLE" || "LDAP", // required
// Created: new Date("TIMESTAMP"), // required
// Description: "STRING_VALUE", // required
// EngineType: "ACTIVEMQ" || "RABBITMQ", // required
// EngineVersion: "STRING_VALUE", // required
// Id: "STRING_VALUE", // required
// LatestRevision: { // ConfigurationRevision
// Created: new Date("TIMESTAMP"), // required
// Description: "STRING_VALUE",
// Revision: Number("int"), // required
// },
// Name: "STRING_VALUE", // required
// Tags: { // __mapOf__string
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// MaxResults: Number("int"),
// NextToken: "STRING_VALUE",
// };
ListConfigurationsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
MaxResults | number | undefined | The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. |
NextToken | string | undefined | The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. |
ListConfigurationsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Configurations | Configuration[] | undefined | The list of all revisions for the specified configuration. |
MaxResults | number | undefined | The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100. |
NextToken | string | undefined | The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
BadRequestException | client | Returns information about an error. |
ForbiddenException | client | Returns information about an error. |
InternalServerErrorException | server | Returns information about an error. |
MqServiceException | Base exception class for all service exceptions from Mq service. |