Table of Contents
A low-level client representing AmazonMQ Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.:
import boto3
client = boto3.client('mq')
These are the available methods:
Check if an operation can be paginated.
Creates a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.create_broker(
AuthenticationStrategy='SIMPLE'|'LDAP',
AutoMinorVersionUpgrade=True|False,
BrokerName='string',
Configuration={
'Id': 'string',
'Revision': 123
},
CreatorRequestId='string',
DeploymentMode='SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
EncryptionOptions={
'KmsKeyId': 'string',
'UseAwsOwnedKey': True|False
},
EngineType='ACTIVEMQ'|'RABBITMQ',
EngineVersion='string',
HostInstanceType='string',
LdapServerMetadata={
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
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',
],
StorageType='EBS'|'EFS',
SubnetIds=[
'string',
],
Tags={
'string': 'string'
},
Users=[
{
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'Password': 'string',
'Username': 'string'
},
]
)
A list of information about the configuration.
Encryption options for the broker.
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Enables Amazon CloudWatch logging for brokers.
The parameters that determine the WeeklyStartTime.
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
The list of groups 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 (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.
Create tags when creating the broker.
Required. The list of broker users (persons or applications) who can access queues and topics. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ Web Console. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
dict
Response Syntax
{
'BrokerArn': 'string',
'BrokerId': 'string'
}
Response Structure
Exceptions
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(
AuthenticationStrategy='SIMPLE'|'LDAP',
EngineType='ACTIVEMQ'|'RABBITMQ',
EngineVersion='string',
Name='string',
Tags={
'string': 'string'
}
)
Create tags when creating the configuration.
dict
Response Syntax
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
Exceptions
Add a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
ResourceArn='string',
Tags={
'string': 'string'
}
)
The key-value pair for the resource tag.
None
Exceptions
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'
)
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.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.delete_broker(
BrokerId='string'
)
{
'BrokerId': 'string'
}
Response Structure
Exceptions
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED] An array of tag keys to delete
None
Exceptions
Deletes an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
BrokerId='string',
Username='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
response = client.describe_broker(
BrokerId='string'
)
{
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'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'|'CLUSTER_MULTI_AZ',
'EncryptionOptions': {
'KmsKeyId': 'string',
'UseAwsOwnedKey': True|False
},
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'EngineVersion': 'string',
'HostInstanceType': 'string',
'LdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'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'
},
'PendingAuthenticationStrategy': 'SIMPLE'|'LDAP',
'PendingEngineVersion': 'string',
'PendingHostInstanceType': 'string',
'PendingLdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'PendingSecurityGroups': [
'string',
],
'PubliclyAccessible': True|False,
'SecurityGroups': [
'string',
],
'StorageType': 'EBS'|'EFS',
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'Users': [
{
'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
'Username': 'string'
},
]
}
Response Structure
Warning
Does not apply to RabbitMQ brokers.
Exceptions
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'
)
dict
Response Syntax
{
'BrokerEngineTypes': [
{
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'EngineVersions': [
{
'Name': 'string'
},
]
},
],
'MaxResults': 123,
'NextToken': 'string'
}
Response Structure
Exceptions
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',
StorageType='string'
)
dict
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
Exceptions
Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration(
ConfigurationId='string'
)
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
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'
)
dict
Response Syntax
{
'ConfigurationId': 'string',
'Created': datetime(2015, 1, 1),
'Data': 'string',
'Description': 'string'
}
Response Structure
Exceptions
Returns information about an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
BrokerId='string',
Username='string'
)
dict
Response Syntax
{
'BrokerId': 'string',
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'Pending': {
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'PendingChange': 'CREATE'|'UPDATE'|'DELETE'
},
'Username': 'string'
}
Response Structure
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns a list of all brokers.
See also: AWS API Documentation
Request Syntax
response = client.list_brokers(
MaxResults=123,
NextToken='string'
)
dict
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'|'CLUSTER_MULTI_AZ',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'HostInstanceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
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'
)
dict
Response Syntax
{
'ConfigurationId': 'string',
'MaxResults': 123,
'NextToken': 'string',
'Revisions': [
{
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
]
}
Response Structure
Exceptions
Returns a list of all configurations.
See also: AWS API Documentation
Request Syntax
response = client.list_configurations(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Configurations': [
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'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
Exceptions
Lists tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceArn='string'
)
{
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Returns a list of all ActiveMQ users.
See also: AWS API Documentation
Request Syntax
response = client.list_users(
BrokerId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'BrokerId': 'string',
'MaxResults': 123,
'NextToken': 'string',
'Users': [
{
'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
'Username': 'string'
},
]
}
Response Structure
Exceptions
Reboots a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.reboot_broker(
BrokerId='string'
)
{}
Response Structure
Exceptions
Adds a pending configuration change to a broker.
See also: AWS API Documentation
Request Syntax
response = client.update_broker(
AuthenticationStrategy='SIMPLE'|'LDAP',
AutoMinorVersionUpgrade=True|False,
BrokerId='string',
Configuration={
'Id': 'string',
'Revision': 123
},
EngineVersion='string',
HostInstanceType='string',
LdapServerMetadata={
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
Logs={
'Audit': True|False,
'General': True|False
},
SecurityGroups=[
'string',
]
)
A list of information about the configuration.
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Enables Amazon CloudWatch logging for brokers.
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
dict
Response Syntax
{
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'AutoMinorVersionUpgrade': True|False,
'BrokerId': 'string',
'Configuration': {
'Id': 'string',
'Revision': 123
},
'EngineVersion': 'string',
'HostInstanceType': 'string',
'LdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'Logs': {
'Audit': True|False,
'General': True|False
},
'SecurityGroups': [
'string',
]
}
Response Structure
Exceptions
Updates the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration(
ConfigurationId='string',
Data='string',
Description='string'
)
dict
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
Exceptions
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'
)
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.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('list_brokers')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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'|'CLUSTER_MULTI_AZ',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'HostInstanceType': 'string'
},
],
}
Response Structure