MQ / Client / describe_broker_instance_options

describe_broker_instance_options#

MQ.Client.describe_broker_instance_options(**kwargs)#

Describe available broker instance options.

Request Syntax

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

Parameters:

EngineType (string) – Filter response by engine type.
HostInstanceType (string) – Filter response by host instance 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.
StorageType (string) – Filter response by storage type.

Return type:

dict

Returns:

Response Syntax

{
    'BrokerInstanceOptions': [
        {
            'AvailabilityZones': [
                {
                    'Name': 'string'
                },
            ],
            'EngineType': 'ACTIVEMQ'|'RABBITMQ',
            'HostInstanceType': 'string',
            'StorageType': 'EBS'|'EFS',
            'SupportedDeploymentModes': [
                'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
            ],
            '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 broker’s engine type.
    - HostInstanceType (string) –
      
      The broker’s instance type.
    - StorageType (string) –
      
      The broker’s storage type.
    - SupportedDeploymentModes (list) –
      
      The list of supported deployment modes.
      - (string) –
        
        The broker’s deployment mode.
    - 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.

Exceptions

MQ.Client.exceptions.BadRequestException
MQ.Client.exceptions.InternalServerErrorException
MQ.Client.exceptions.ForbiddenException