AmazonMQ

Describe available broker instance options.

See also: AWS API Documentation

Request Syntax

client.describe_broker_instance_options(
    EngineType='string',
    HostInstanceType='string',
    MaxResults=123,
    NextToken='string'
)

type EngineType:

string

param EngineType:

Filter response by engine type.

type HostInstanceType:

string

param HostInstanceType:

Filter response by host instance type.

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'BrokerInstanceOptions': [
        {
            'AvailabilityZones': [
                {
                    'Name': 'string'
                },
            ],
            'EngineType': 'ACTIVEMQ',
            'HostInstanceType': 'string',
            'SupportedEngineVersions': [
                'string',
            ]
        },
    ],
    'MaxResults': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) -- HTTP Status Code 200: OK.

  • BrokerInstanceOptions (list) -- List of available broker instance options.

    • (dict) -- Option for host instance type.

      • AvailabilityZones (list) -- The list of available az.

        • (dict) -- 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.

      • 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.

Describe available engine types and versions.

See also: AWS API Documentation

Request Syntax

client.describe_broker_engine_types(
    EngineType='string',
    MaxResults=123,
    NextToken='string'
)

type EngineType:

string

param EngineType:

Filter response by engine type.

type MaxResults:

integer

param MaxResults:

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.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'BrokerEngineTypes': [
        {
            'EngineType': 'ACTIVEMQ',
            'EngineVersions': [
                {
                    'Name': 'string'
                },
            ]
        },
    ],
    'MaxResults': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) -- HTTP Status Code 200: OK.

  • BrokerEngineTypes (list) -- List of available engine types and versions.

    • (dict) -- Types of broker engines.

      • EngineType (string) -- The type of broker engine.

      • EngineVersions (list) -- The list of engine versions.

        • (dict) -- 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.