import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeBrokerRequest, DescribeBrokerResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeBrokerCommand}. */ export interface DescribeBrokerCommandInput extends DescribeBrokerRequest { } /** * @public * * The output of {@link DescribeBrokerCommand}. */ export interface DescribeBrokerCommandOutput extends DescribeBrokerResponse, __MetadataBearer { } declare const DescribeBrokerCommand_base: { new (input: DescribeBrokerCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeBrokerCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the specified broker.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { MqClient, DescribeBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import * // const { MqClient, DescribeBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import * // import type { MqClientConfig } from "@aws-sdk/client-mq"; * const config = {}; // type is MqClientConfig * const client = new MqClient(config); * const input = { // DescribeBrokerRequest * BrokerId: "STRING_VALUE", // required * }; * const command = new DescribeBrokerCommand(input); * const response = await client.send(command); * // { // DescribeBrokerResponse * // ActionsRequired: [ // __listOfActionRequired * // { // ActionRequired * // ActionRequiredCode: "STRING_VALUE", * // ActionRequiredInfo: "STRING_VALUE", * // }, * // ], * // AuthenticationStrategy: "SIMPLE" || "LDAP" || "CONFIG_MANAGED", * // AutoMinorVersionUpgrade: true || false, * // BrokerArn: "STRING_VALUE", * // BrokerId: "STRING_VALUE", * // BrokerInstances: [ // __listOfBrokerInstance * // { // BrokerInstance * // ConsoleURL: "STRING_VALUE", * // Endpoints: [ // __listOf__string * // "STRING_VALUE", * // ], * // IpAddress: "STRING_VALUE", * // }, * // ], * // BrokerName: "STRING_VALUE", * // BrokerState: "CREATION_IN_PROGRESS" || "CREATION_FAILED" || "DELETION_IN_PROGRESS" || "RUNNING" || "REBOOT_IN_PROGRESS" || "CRITICAL_ACTION_REQUIRED" || "REPLICA", * // Configurations: { // Configurations * // Current: { // ConfigurationId * // Id: "STRING_VALUE", // required * // Revision: Number("int"), * // }, * // History: [ // __listOfConfigurationId * // { * // Id: "STRING_VALUE", // required * // Revision: Number("int"), * // }, * // ], * // Pending: { * // Id: "STRING_VALUE", // required * // Revision: Number("int"), * // }, * // }, * // Created: new Date("TIMESTAMP"), * // DeploymentMode: "SINGLE_INSTANCE" || "ACTIVE_STANDBY_MULTI_AZ" || "CLUSTER_MULTI_AZ", * // EncryptionOptions: { // EncryptionOptions * // KmsKeyId: "STRING_VALUE", * // UseAwsOwnedKey: true || false, // required * // }, * // EngineType: "ACTIVEMQ" || "RABBITMQ", * // EngineVersion: "STRING_VALUE", * // HostInstanceType: "STRING_VALUE", * // LdapServerMetadata: { // LdapServerMetadataOutput * // Hosts: [ // required * // "STRING_VALUE", * // ], * // RoleBase: "STRING_VALUE", // required * // RoleName: "STRING_VALUE", * // RoleSearchMatching: "STRING_VALUE", // required * // RoleSearchSubtree: true || false, * // ServiceAccountUsername: "STRING_VALUE", // required * // UserBase: "STRING_VALUE", // required * // UserRoleName: "STRING_VALUE", * // UserSearchMatching: "STRING_VALUE", // required * // UserSearchSubtree: true || false, * // }, * // Logs: { // LogsSummary * // Audit: true || false, * // AuditLogGroup: "STRING_VALUE", * // General: true || false, // required * // GeneralLogGroup: "STRING_VALUE", // required * // Pending: { // PendingLogs * // Audit: true || false, * // General: true || false, * // }, * // }, * // MaintenanceWindowStartTime: { // WeeklyStartTime * // DayOfWeek: "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY", // required * // TimeOfDay: "STRING_VALUE", // required * // TimeZone: "STRING_VALUE", * // }, * // PendingAuthenticationStrategy: "SIMPLE" || "LDAP" || "CONFIG_MANAGED", * // PendingEngineVersion: "STRING_VALUE", * // PendingHostInstanceType: "STRING_VALUE", * // PendingLdapServerMetadata: { * // Hosts: [ // required * // "STRING_VALUE", * // ], * // RoleBase: "STRING_VALUE", // required * // RoleName: "STRING_VALUE", * // RoleSearchMatching: "STRING_VALUE", // required * // RoleSearchSubtree: true || false, * // ServiceAccountUsername: "STRING_VALUE", // required * // UserBase: "STRING_VALUE", // required * // UserRoleName: "STRING_VALUE", * // UserSearchMatching: "STRING_VALUE", // required * // UserSearchSubtree: true || false, * // }, * // PendingSecurityGroups: "<__listOf__string>", * // PendingStorageSize: Number("int"), * // PubliclyAccessible: true || false, * // SecurityGroups: "<__listOf__string>", * // StorageSize: Number("int"), * // StorageType: "EBS" || "EFS", * // SubnetIds: "<__listOf__string>", * // Tags: { // __mapOf__string * // "": "STRING_VALUE", * // }, * // Users: [ // __listOfUserSummary * // { // UserSummary * // PendingChange: "CREATE" || "UPDATE" || "DELETE", * // Username: "STRING_VALUE", // required * // }, * // ], * // DataReplicationMetadata: { // DataReplicationMetadataOutput * // DataReplicationCounterpart: { // DataReplicationCounterpart * // BrokerId: "STRING_VALUE", // required * // Region: "STRING_VALUE", // required * // }, * // DataReplicationRole: "STRING_VALUE", // required * // }, * // DataReplicationMode: "NONE" || "CRDR", * // PendingDataReplicationMetadata: { * // DataReplicationCounterpart: { * // BrokerId: "STRING_VALUE", // required * // Region: "STRING_VALUE", // required * // }, * // DataReplicationRole: "STRING_VALUE", // required * // }, * // PendingDataReplicationMode: "NONE" || "CRDR", * // }; * * ``` * * @param DescribeBrokerCommandInput - {@link DescribeBrokerCommandInput} * @returns {@link DescribeBrokerCommandOutput} * @see {@link DescribeBrokerCommandInput} for command's `input` shape. * @see {@link DescribeBrokerCommandOutput} for command's `response` shape. * @see {@link MqClientResolvedConfig | config} for MqClient's `config` shape. * * @throws {@link BadRequestException} (client fault) *

Returns information about an error.

* * @throws {@link ForbiddenException} (client fault) *

Returns information about an error.

* * @throws {@link InternalServerErrorException} (server fault) *

Returns information about an error.

* * @throws {@link NotFoundException} (client fault) *

Returns information about an error.

* * @throws {@link MqServiceException} *

Base exception class for all service exceptions from Mq service.

* * * @public */ export declare class DescribeBrokerCommand extends DescribeBrokerCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeBrokerRequest; output: DescribeBrokerResponse; }; sdk: { input: DescribeBrokerCommandInput; output: DescribeBrokerCommandOutput; }; }; }