MQ

Table of Contents

Client

class MQ.Client

A low-level client representing AmazonMQ:

import boto3

client = boto3.client('mq')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_broker(**kwargs)

Creates a broker. Note: This API is asynchronous.

See also: AWS API Documentation

Request Syntax

response = client.create_broker(
    AutoMinorVersionUpgrade=True|False,
    BrokerName='string',
    Configuration={
        'Id': 'string',
        'Revision': 123
    },
    CreatorRequestId='string',
    DeploymentMode='SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
    EngineType='ACTIVEMQ',
    EngineVersion='string',
    HostInstanceType='string',
    Logs={
        'Audit': True|False,
        'General': True|False
    },
    MaintenanceWindowStartTime={
        'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
        'TimeOfDay': 'string',
        'TimeZone': 'string'
    },
    PubliclyAccessible=True|False,
    SecurityGroups=[
        'string',
    ],
    SubnetIds=[
        'string',
    ],
    Tags={
        'string': 'string'
    },
    Users=[
        {
            'ConsoleAccess': True|False,
            'Groups': [
                'string',
            ],
            'Password': 'string',
            'Username': 'string'
        },
    ]
)
Parameters
  • 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.
  • BrokerName (string) -- 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.
  • Configuration (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.
  • CreatorRequestId (string) -- The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.This field is autopopulated if not provided.
  • 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) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  • HostInstanceType (string) -- Required. The broker's instance type.
  • Logs (dict) --

    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.
  • 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.
  • PubliclyAccessible (boolean) -- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  • SecurityGroups (list) --

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

    Create tags when creating the broker.

    • (string) --
      • (string) --
  • Users (list) --

    Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

    • (dict) -- An ActiveMQ user associated with the broker.
      • ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
      • Groups (list) -- The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
        • (string) --
      • Password (string) -- Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
      • 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.
Return type

dict

Returns

Response Syntax

{
    'BrokerArn': 'string',
    'BrokerId': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
    • BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.

create_configuration(**kwargs)

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

See also: AWS API Documentation

Request Syntax

response = client.create_configuration(
    EngineType='ACTIVEMQ',
    EngineVersion='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
  • EngineVersion (string) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  • Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
  • Tags (dict) --

    Create tags when creating the configuration.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Created': datetime(2015, 1, 1),
    'Id': 'string',
    'LatestRevision': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Revision': 123
    },
    'Name': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • Arn (string) -- Required. The Amazon Resource Name (ARN) of the configuration.
    • Created (datetime) -- Required. The date and time of the configuration.
    • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
    • LatestRevision (dict) -- The latest revision of the configuration.
      • Created (datetime) -- Required. The date and time of the configuration revision.
      • Description (string) -- The description of the configuration revision.
      • Revision (integer) -- Required. The revision number of the configuration.
    • Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.

create_tags(**kwargs)

Add a tag to a resource.

See also: AWS API Documentation

Request Syntax

response = client.create_tags(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
  • Tags (dict) --

    The key-value pair for the resource tag.

    • (string) --
      • (string) --
Returns

None

create_user(**kwargs)

Creates an ActiveMQ user.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    BrokerId='string',
    ConsoleAccess=True|False,
    Groups=[
        'string',
    ],
    Password='string',
    Username='string'
)
Parameters
  • BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
  • ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
  • Groups (list) --

    The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

    • (string) --
  • Password (string) -- Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
  • 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

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

delete_broker(**kwargs)

Deletes a broker. Note: This API is asynchronous.

See also: AWS API Documentation

Request Syntax

response = client.delete_broker(
    BrokerId='string'
)
Parameters
BrokerId (string) -- [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.
Return type
dict
Returns
Response Syntax
{
    'BrokerId': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.
delete_tags(**kwargs)

Removes a tag from a resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_tags(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
  • TagKeys (list) --

    [REQUIRED] An array of tag keys to delete

    • (string) --
Returns

None

delete_user(**kwargs)

Deletes an ActiveMQ user.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    BrokerId='string',
    Username='string'
)
Parameters
  • BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
  • 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

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

describe_broker(**kwargs)

Returns information about the specified broker.

See also: AWS API Documentation

Request Syntax

response = client.describe_broker(
    BrokerId='string'
)
Parameters
BrokerId (string) -- [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.
Return type
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',
    ],
    'Tags': {
        'string': '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. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    • 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. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    • 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) --
    • Tags (dict) -- The list of all tags associated with this broker.
      • (string) --
        • (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.
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 engine types 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',
            '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.

describe_broker_instance_options(**kwargs)

Describe available broker instance options.

See also: AWS API Documentation

Request Syntax

response = client.describe_broker_instance_options(
    EngineType='string',
    HostInstanceType='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • EngineType (string) -- Filter response by engine type.
  • HostInstanceType (string) -- Filter response by host instance type.
  • MaxResults (integer) -- 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.
  • 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

{
    '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_configuration(**kwargs)

Returns information about the specified configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration(
    ConfigurationId='string'
)
Parameters
ConfigurationId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Created': datetime(2015, 1, 1),
    'Description': 'string',
    'EngineType': 'ACTIVEMQ',
    'EngineVersion': 'string',
    'Id': 'string',
    'LatestRevision': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Revision': 123
    },
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • Arn (string) -- Required. The ARN of the configuration.
    • Created (datetime) -- Required. The date and time of the configuration revision.
    • Description (string) -- Required. The description of the configuration.
    • EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    • EngineVersion (string) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
    • LatestRevision (dict) -- Required. The latest revision of the configuration.
      • Created (datetime) -- Required. The date and time of the configuration revision.
      • Description (string) -- The description of the configuration revision.
      • Revision (integer) -- Required. The revision number of the configuration.
    • Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
    • Tags (dict) -- The list of all tags associated with this configuration.
      • (string) --
        • (string) --
describe_configuration_revision(**kwargs)

Returns the specified configuration revision for the specified configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_revision(
    ConfigurationId='string',
    ConfigurationRevision='string'
)
Parameters
  • ConfigurationId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
  • ConfigurationRevision (string) -- [REQUIRED] The revision of the configuration.
Return type

dict

Returns

Response Syntax

{
    'ConfigurationId': 'string',
    'Created': datetime(2015, 1, 1),
    'Data': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • ConfigurationId (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
    • Created (datetime) -- Required. The date and time of the configuration.
    • Data (string) -- Required. The base64-encoded XML configuration.
    • Description (string) -- The description of the configuration.

describe_user(**kwargs)

Returns information about an ActiveMQ user.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    BrokerId='string',
    Username='string'
)
Parameters
  • BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'BrokerId': 'string',
    'ConsoleAccess': True|False,
    'Groups': [
        'string',
    ],
    'Pending': {
        'ConsoleAccess': True|False,
        'Groups': [
            'string',
        ],
        'PendingChange': 'CREATE'|'UPDATE'|'DELETE'
    },
    'Username': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerId (string) -- Required. The unique ID that Amazon MQ generates for the broker.
    • ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
    • Groups (list) -- The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
      • (string) --
    • Pending (dict) -- The status of the changes pending for the ActiveMQ user.
      • ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
      • Groups (list) -- The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
        • (string) --
      • PendingChange (string) -- Required. 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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_brokers(**kwargs)

Returns a list of all brokers.

See also: AWS API Documentation

Request Syntax

response = client.list_brokers(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • 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

{
    'BrokerSummaries': [
        {
            'BrokerArn': 'string',
            'BrokerId': 'string',
            'BrokerName': 'string',
            'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
            'Created': datetime(2015, 1, 1),
            'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
            'HostInstanceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerSummaries (list) -- A list of information about all brokers.
      • (dict) -- The Amazon Resource Name (ARN) of the broker.
        • BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
        • BrokerId (string) -- The unique ID that Amazon MQ generates for 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.
        • Created (datetime) -- The time when the broker was created.
        • DeploymentMode (string) -- Required. The deployment mode of the broker.
        • HostInstanceType (string) -- The broker's instance type.
    • NextToken (string) -- The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

list_configuration_revisions(**kwargs)

Returns a list of all revisions for the specified configuration.

See also: AWS API Documentation

Request Syntax

response = client.list_configuration_revisions(
    ConfigurationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ConfigurationId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
  • MaxResults (integer) -- The maximum number of configurations 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

{
    'ConfigurationId': 'string',
    'MaxResults': 123,
    'NextToken': 'string',
    'Revisions': [
        {
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'Revision': 123
        },
    ]
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • ConfigurationId (string) -- The unique ID that Amazon MQ generates for the configuration.
    • MaxResults (integer) -- The maximum number of configuration revisions 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.
    • Revisions (list) -- The list of all revisions for the specified configuration.
      • (dict) -- Returns information about the specified configuration revision.
        • Created (datetime) -- Required. The date and time of the configuration revision.
        • Description (string) -- The description of the configuration revision.
        • Revision (integer) -- Required. The revision number of the configuration.

list_configurations(**kwargs)

Returns a list of all configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_configurations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of configurations 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

{
    'Configurations': [
        {
            'Arn': 'string',
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'EngineType': 'ACTIVEMQ',
            'EngineVersion': 'string',
            'Id': 'string',
            'LatestRevision': {
                'Created': datetime(2015, 1, 1),
                'Description': 'string',
                'Revision': 123
            },
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'MaxResults': 123,
    'NextToken': 'string'
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • Configurations (list) -- The list of all revisions for the specified configuration.
      • (dict) -- Returns information about all configurations.
        • Arn (string) -- Required. The ARN of the configuration.
        • Created (datetime) -- Required. The date and time of the configuration revision.
        • Description (string) -- Required. The description of the configuration.
        • EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
        • EngineVersion (string) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
        • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
        • LatestRevision (dict) -- Required. The latest revision of the configuration.
          • Created (datetime) -- Required. The date and time of the configuration revision.
          • Description (string) -- The description of the configuration revision.
          • Revision (integer) -- Required. The revision number of the configuration.
        • Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
        • Tags (dict) -- The list of all tags associated with this configuration.
          • (string) --
            • (string) --
    • MaxResults (integer) -- The maximum number of configurations 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.

list_tags(**kwargs)

Lists tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ResourceArn='string'
)
Parameters
ResourceArn (string) -- [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • Tags (dict) -- The key-value pair for the resource tag.
      • (string) --
        • (string) --
list_users(**kwargs)

Returns a list of all ActiveMQ users.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    BrokerId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
  • MaxResults (integer) -- The maximum number of ActiveMQ users 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.
Return type

dict

Returns

Response Syntax

{
    'BrokerId': 'string',
    'MaxResults': 123,
    'NextToken': 'string',
    'Users': [
        {
            'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
            'Username': 'string'
        },
    ]
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerId (string) -- Required. The unique ID that Amazon MQ generates for the broker.
    • MaxResults (integer) -- Required. The maximum number of ActiveMQ users 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.
    • Users (list) -- Required. 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.

reboot_broker(**kwargs)

Reboots a broker. Note: This API is asynchronous.

See also: AWS API Documentation

Request Syntax

response = client.reboot_broker(
    BrokerId='string'
)
Parameters
BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
Return type
dict
Returns
Response Syntax
{}

Response Structure

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

Adds a pending configuration change to a broker.

See also: AWS API Documentation

Request Syntax

response = client.update_broker(
    AutoMinorVersionUpgrade=True|False,
    BrokerId='string',
    Configuration={
        'Id': 'string',
        'Revision': 123
    },
    EngineVersion='string',
    Logs={
        'Audit': True|False,
        'General': True|False
    }
)
Parameters
  • AutoMinorVersionUpgrade (boolean) -- 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.
  • BrokerId (string) -- [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.
  • Configuration (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.
  • EngineVersion (string) -- The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  • Logs (dict) --

    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.
Return type

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. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    • 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.

update_configuration(**kwargs)

Updates the specified configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_configuration(
    ConfigurationId='string',
    Data='string',
    Description='string'
)
Parameters
  • ConfigurationId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
  • Data (string) -- Required. The base64-encoded XML configuration.
  • Description (string) -- The description of the configuration.
Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Created': datetime(2015, 1, 1),
    'Id': 'string',
    'LatestRevision': {
        'Created': datetime(2015, 1, 1),
        'Description': 'string',
        'Revision': 123
    },
    'Name': 'string',
    'Warnings': [
        {
            'AttributeName': 'string',
            'ElementName': 'string',
            'Reason': 'DISALLOWED_ELEMENT_REMOVED'|'DISALLOWED_ATTRIBUTE_REMOVED'|'INVALID_ATTRIBUTE_VALUE_REMOVED'
        },
    ]
}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • Arn (string) -- Required. The Amazon Resource Name (ARN) of the configuration.
    • Created (datetime) -- Required. The date and time of the configuration.
    • Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
    • LatestRevision (dict) -- The latest revision of the configuration.
      • Created (datetime) -- Required. The date and time of the configuration revision.
      • Description (string) -- The description of the configuration revision.
      • Revision (integer) -- Required. The revision number of the configuration.
    • Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
    • Warnings (list) -- The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.
      • (dict) -- Returns information about the XML element or attribute that was sanitized in the configuration.
        • AttributeName (string) -- The name of the XML attribute that has been sanitized.
        • ElementName (string) -- The name of the XML element that has been sanitized.
        • Reason (string) -- Required. The reason for which the XML elements or attributes were sanitized.

update_user(**kwargs)

Updates the information for an ActiveMQ user.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    BrokerId='string',
    ConsoleAccess=True|False,
    Groups=[
        'string',
    ],
    Password='string',
    Username='string'
)
Parameters
  • BrokerId (string) -- [REQUIRED] The unique ID that Amazon MQ generates for the broker.
  • ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
  • Groups (list) --

    The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

    • (string) --
  • Password (string) -- The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
  • Username (string) -- [REQUIRED] 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.
Return type

dict

Returns

Response Syntax

{}

Response Structure

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

Paginators

The available paginators are:

class MQ.Paginator.ListBrokers
paginator = client.get_paginator('list_brokers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from MQ.Client.list_brokers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'BrokerSummaries': [
        {
            'BrokerArn': 'string',
            'BrokerId': 'string',
            'BrokerName': 'string',
            'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
            'Created': datetime(2015, 1, 1),
            'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
            'HostInstanceType': 'string'
        },
    ],

}

Response Structure

  • (dict) -- HTTP Status Code 200: OK.
    • BrokerSummaries (list) -- A list of information about all brokers.
      • (dict) -- The Amazon Resource Name (ARN) of the broker.
        • BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
        • BrokerId (string) -- The unique ID that Amazon MQ generates for 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.
        • Created (datetime) -- The time when the broker was created.
        • DeploymentMode (string) -- Required. The deployment mode of the broker.
        • HostInstanceType (string) -- The broker's instance type.