Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mq ]

describe-broker-instance-options

Description

Describe available broker instance options.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-broker-instance-options
[--engine-type <value>]
[--host-instance-type <value>]
[--max-results <value>]
[--next-token <value>]
[--storage-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--engine-type (string) Filter response by engine type.

--host-instance-type (string) Filter response by host instance type.

--max-results (integer) The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

--next-token (string) The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

--storage-type (string) Filter response by storage type.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

BrokerInstanceOptions -> (list)

List of available broker instance options.

(structure)

Option for host instance type.

AvailabilityZones -> (list)

The list of available az.

(structure)

Name of the availability zone.

Name -> (string)

Id for the availability zone.

EngineType -> (string)

The type of broker engine.

HostInstanceType -> (string)

The type of broker instance.

StorageType -> (string)

The broker's storage type.

SupportedDeploymentModes -> (list)

The list of supported deployment modes.

(string)

The deployment mode of the broker.

SupportedEngineVersions -> (list)

The list of supported engine versions.

(string)

MaxResults -> (integer)

Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.

NextToken -> (string)

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.