[ aws . mq ]

describe-broker-engine-types

Description

Describe available engine types and versions.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-broker-engine-types
[--engine-type <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

--max-results (integer) The maximum number of engine types 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

BrokerEngineTypes -> (list)

List of available engine types and versions.

(structure)

Types of broker engines.

EngineType -> (string)

The type of broker engine.

EngineVersions -> (list)

The list of engine versions.

(structure)

Id of the engine version.

Name -> (string)

Id for the version.

MaxResults -> (integer)

Required. The maximum number of engine types 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.