AmazonMQ

{'PendingEngineVersion': 'string'}

Returns information about the specified broker.

See also: AWS API Documentation

Request Syntax

client.describe_broker(
    BrokerId='string'
)

type BrokerId:

string

param BrokerId:

[REQUIRED] The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

rtype:

dict

returns:

Response Syntax

{
    'AutoMinorVersionUpgrade': True|False,
    'BrokerArn': 'string',
    'BrokerId': 'string',
    'BrokerInstances': [
        {
            'ConsoleURL': 'string',
            'Endpoints': [
                'string',
            ],
            'IpAddress': 'string'
        },
    ],
    'BrokerName': 'string',
    'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
    'Configurations': {
        'Current': {
            'Id': 'string',
            'Revision': 123
        },
        'History': [
            {
                'Id': 'string',
                'Revision': 123
            },
        ],
        'Pending': {
            'Id': 'string',
            'Revision': 123
        }
    },
    'Created': datetime(2015, 1, 1),
    'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
    'EngineType': 'ACTIVEMQ',
    'EngineVersion': 'string',
    'HostInstanceType': 'string',
    'Logs': {
        'Audit': True|False,
        'AuditLogGroup': 'string',
        'General': True|False,
        'GeneralLogGroup': 'string',
        'Pending': {
            'Audit': True|False,
            'General': True|False
        }
    },
    'MaintenanceWindowStartTime': {
        'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
        'TimeOfDay': 'string',
        'TimeZone': 'string'
    },
    'PendingEngineVersion': 'string',
    'PubliclyAccessible': True|False,
    'SecurityGroups': [
        'string',
    ],
    'SubnetIds': [
        'string',
    ],
    'Users': [
        {
            'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
            'Username': 'string'
        },
    ]
}

Response Structure

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

  • AutoMinorVersionUpgrade (boolean) -- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

  • BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.

  • BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.

  • BrokerInstances (list) -- A list of information about allocated brokers.

    • (dict) -- Returns information about all brokers.

      • ConsoleURL (string) -- The URL of the broker's ActiveMQ Web Console.

      • Endpoints (list) -- The broker's wire-level protocol endpoints.

        • (string) --

      • IpAddress (string) -- The IP address of the Elastic Network Interface (ENI) attached to the broker.

  • BrokerName (string) -- The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

  • BrokerState (string) -- The status of the broker.

  • Configurations (dict) -- The list of all revisions for the specified configuration.

    • Current (dict) -- The current configuration of the broker.

      • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.

      • Revision (integer) -- The revision number of the configuration.

    • History (list) -- The history of configurations applied to the broker.

      • (dict) -- A list of information about the configuration.

        • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.

        • Revision (integer) -- The revision number of the configuration.

    • Pending (dict) -- The pending configuration of the broker.

      • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.

      • Revision (integer) -- The revision number of the configuration.

  • Created (datetime) -- The time when the broker was created.

  • DeploymentMode (string) -- Required. The deployment mode of the broker.

  • EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

  • EngineVersion (string) -- The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.

  • HostInstanceType (string) -- The broker's instance type.

  • Logs (dict) -- The list of information about logs currently enabled and pending to be deployed for the specified broker.

    • Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

    • AuditLogGroup (string) -- The location of the CloudWatch Logs log group where audit logs are sent.

    • General (boolean) -- Enables general logging.

    • GeneralLogGroup (string) -- The location of the CloudWatch Logs log group where general logs are sent.

    • Pending (dict) -- The list of information about logs pending to be deployed for the specified broker.

      • Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

      • General (boolean) -- Enables general logging.

  • MaintenanceWindowStartTime (dict) -- The parameters that determine the WeeklyStartTime.

    • DayOfWeek (string) -- Required. The day of the week.

    • TimeOfDay (string) -- Required. The time, in 24-hour format.

    • TimeZone (string) -- The time zone, UTC by default, in either the Country/City format, or the UTC offset format.

  • PendingEngineVersion (string) -- The version of the broker engine to upgrade to.

  • PubliclyAccessible (boolean) -- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.

  • SecurityGroups (list) -- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    • (string) --

  • SubnetIds (list) -- The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

    • (string) --

  • Users (list) -- The list of all ActiveMQ usernames for the specified broker.

    • (dict) -- Returns a list of all ActiveMQ users.

      • PendingChange (string) -- The type of change pending for the ActiveMQ user.

      • Username (string) -- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

{'AutoMinorVersionUpgrade': 'boolean', 'EngineVersion': 'string'}

Adds a pending configuration change to a broker.

See also: AWS API Documentation

Request Syntax

client.update_broker(
    AutoMinorVersionUpgrade=True|False,
    BrokerId='string',
    Configuration={
        'Id': 'string',
        'Revision': 123
    },
    EngineVersion='string',
    Logs={
        'Audit': True|False,
        'General': True|False
    }
)

type AutoMinorVersionUpgrade:

boolean

param AutoMinorVersionUpgrade:

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

type BrokerId:

string

param BrokerId:

[REQUIRED] The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

type Configuration:

dict

param Configuration:

A list of information about the configuration.

• Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.

• Revision (integer) -- The revision number of the configuration.

type EngineVersion:

string

param EngineVersion:

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.

type Logs:

dict

param Logs:

Enables Amazon CloudWatch logging for brokers.

• Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

• General (boolean) -- Enables general logging.

rtype:

dict

returns:

Response Syntax

{
    'AutoMinorVersionUpgrade': True|False,
    'BrokerId': 'string',
    'Configuration': {
        'Id': 'string',
        'Revision': 123
    },
    'EngineVersion': 'string',
    'Logs': {
        'Audit': True|False,
        'General': True|False
    }
}

Response Structure

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

  • AutoMinorVersionUpgrade (boolean) -- The new value of automatic upgrades to new minor version for brokers.

  • BrokerId (string) -- Required. The unique ID that Amazon MQ generates for the broker.

  • Configuration (dict) -- The ID of the updated configuration.

    • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.

    • Revision (integer) -- The revision number of the configuration.

  • EngineVersion (string) -- The version of the broker engine to upgrade to.

  • Logs (dict) -- The list of information about logs to be enabled for the specified broker.

    • Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

    • General (boolean) -- Enables general logging.