MQ / Client / describe_broker_engine_types

describe_broker_engine_types#

MQ.Client.describe_broker_engine_types(**kwargs)#

Describe available engine types and versions.

See also: AWS API Documentation

Request Syntax

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

  • EngineType (string) – Filter response by engine type.

  • MaxResults (integer) – 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) – The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Return type:

dict

Returns:

Response Syntax

{
    'BrokerEngineTypes': [
        {
            'EngineType': 'ACTIVEMQ'|'RABBITMQ',
            '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 broker’s engine type.

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

Exceptions

  • MQ.Client.exceptions.BadRequestException

  • MQ.Client.exceptions.InternalServerErrorException

  • MQ.Client.exceptions.ForbiddenException