Table of Contents
MQ.Client¶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:
can_paginate()close()create_broker()create_configuration()create_tags()create_user()delete_broker()delete_tags()delete_user()describe_broker()describe_broker_engine_types()describe_broker_instance_options()describe_configuration()describe_configuration_revision()describe_user()get_paginator()get_waiter()list_brokers()list_configuration_revisions()list_configurations()list_tags()list_users()reboot_broker()update_broker()update_configuration()update_user()can_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_broker(**kwargs)¶Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide .
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'
},
]
)
[REQUIRED]
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
[REQUIRED]
Required. The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
A list of information about the configuration.
Required. The unique ID that Amazon MQ generates for the configuration.
The revision number of the configuration.
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.
[REQUIRED]
Required. The broker's deployment mode.
Encryption options for the broker. Does not apply to RabbitMQ brokers.
The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
[REQUIRED]
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
[REQUIRED]
Required. The broker engine's version. For a list of supported engine versions, see Supported engines .
[REQUIRED]
Required. The broker's instance type.
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
Specifies the name of the LDAP attribute for the user group membership.
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
The directory search scope for the user. If set to true, scope is to search the entire subtree.
Enables Amazon CloudWatch logging for brokers.
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
Enables general logging.
The parameters that determine the WeeklyStartTime.
Required. The day of the week.
Required. The time, in 24-hour format.
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
[REQUIRED]
Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
Warning
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
Create tags when creating the broker.
[REQUIRED]
Required. The list of broker 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.
Warning
Amazon MQ for RabbitMQ
When you create an Amazon MQ for RabbitMQ broker, 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.
A user associated with the broker. 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.
Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
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. Does not apply to RabbitMQ brokers.
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, colons, or equal signs (,:=).
important>Amazon MQ for ActiveMQ For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
/important>
Warning
Amazon MQ for RabbitMQ
For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
dict
Response Syntax
{
'BrokerArn': 'string',
'BrokerId': 'string'
}
Response Structure
(dict) --
HTTP Status Code 200: OK.
BrokerArn (string) --
The broker's Amazon Resource Name (ARN).
BrokerId (string) --
The unique ID that Amazon MQ generates for the broker.
Exceptions
MQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.UnauthorizedExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptioncreate_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(
AuthenticationStrategy='SIMPLE'|'LDAP',
EngineType='ACTIVEMQ'|'RABBITMQ',
EngineVersion='string',
Name='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
[REQUIRED]
Required. The broker engine's version. For a list of supported engine versions, see Supported engines .
[REQUIRED]
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 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
(dict) --
HTTP Status Code 200: OK.
Arn (string) --
Required. The Amazon Resource Name (ARN) of the configuration.
AuthenticationStrategy (string) --
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
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.
Exceptions
MQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptionAdd a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource tag.
The key-value pair for the resource tag.
None
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptioncreate_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'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
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.
[REQUIRED]
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, colons, or equal signs (,:=).
[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.
dict
Response Syntax
{}
Response Structure
(dict) --
HTTP Status Code 200: OK.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptiondelete_broker(**kwargs)¶Deletes a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.delete_broker(
BrokerId='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
{
'BrokerId': 'string'
}
Response Structure
HTTP Status Code 200: OK.
The unique ID that Amazon MQ generates for the broker.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionRemoves a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource tag.
[REQUIRED]
An array of tag keys to delete
None
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondelete_user(**kwargs)¶Deletes an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
BrokerId='string',
Username='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
[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.
dict
Response Syntax
{}
Response Structure
(dict) --
HTTP Status Code 200: OK.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_broker(**kwargs)¶Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
response = client.describe_broker(
BrokerId='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
{
'ActionsRequired': [
{
'ActionRequiredCode': 'string',
'ActionRequiredInfo': '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'|'CRITICAL_ACTION_REQUIRED',
'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
HTTP Status Code 200: OK.
A list of actions required for a broker.
The action required to resolve a broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.
The code you can use to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing the link for your code from the list of action required codes in Amazon MQ action required codes . Each code references a topic with detailed information, instructions, and recommendations for how to resolve the issue and prevent future occurrences.
Information about the action required to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.
The authentication strategy used to secure the broker. The default is SIMPLE.
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
The broker's Amazon Resource Name (ARN).
The unique ID that Amazon MQ generates for the broker.
A list of information about allocated brokers.
Returns information about all brokers.
The brokers web console URL.
The broker's wire-level protocol endpoints.
The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.
The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.
The broker's status.
The list of all revisions for the specified configuration.
The broker's current configuration.
Required. The unique ID that Amazon MQ generates for the configuration.
The revision number of the configuration.
The history of configurations applied to the broker.
A list of information about the configuration.
Warning
Does not apply to RabbitMQ brokers.
Required. The unique ID that Amazon MQ generates for the configuration.
The revision number of the configuration.
The broker's pending configuration.
Required. The unique ID that Amazon MQ generates for the configuration.
The revision number of the configuration.
The time when the broker was created.
The broker's deployment mode.
Encryption options for the broker. Does not apply to RabbitMQ brokers.
The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
The broker engine's version. For a list of supported engine versions, see Supported engines .
The broker's instance type.
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
Specifies the name of the LDAP attribute for the user group membership.
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
The directory search scope for the user. If set to true, scope is to search the entire subtree.
The list of information about logs currently enabled and pending to be deployed for the specified broker.
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
The location of the CloudWatch Logs log group where audit logs are sent.
Enables general logging.
The location of the CloudWatch Logs log group where general logs are sent.
The list of information about logs pending to be deployed for the specified broker.
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
Enables general logging.
The parameters that determine the WeeklyStartTime.
Required. The day of the week.
Required. The time, in 24-hour format.
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines .
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types .
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
Specifies the name of the LDAP attribute for the user group membership.
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
The directory search scope for the user. If set to true, scope is to search the entire subtree.
The list of pending security groups to authorize connections to brokers.
Enables connections from applications outside of the VPC that hosts the broker's subnets.
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
The broker's storage type.
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
The list of all tags associated with this broker.
The list of all broker usernames for the specified broker.
Returns a list of all broker users. Does not apply to RabbitMQ brokers.
The type of change pending for the broker user.
Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_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'
)
dict
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.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_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',
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
(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.
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.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_configuration(**kwargs)¶Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration(
ConfigurationId='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the configuration.
{
'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
HTTP Status Code 200: OK.
Required. The ARN of the configuration.
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
Required. The date and time of the configuration revision.
Required. The description of the configuration.
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines .
Required. The unique ID that Amazon MQ generates for the configuration.
Required. The latest revision of the configuration.
Required. The date and time of the configuration revision.
The description of the configuration revision.
Required. The revision number of the configuration.
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.
The list of all tags associated with this configuration.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_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'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the configuration.
[REQUIRED]
The revision of the configuration.
dict
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.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptiondescribe_user(**kwargs)¶Returns information about an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
BrokerId='string',
Username='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
[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.
dict
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.
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.
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.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_brokers(**kwargs)¶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'|'CRITICAL_ACTION_REQUIRED',
'Created': datetime(2015, 1, 1),
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'HostInstanceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HTTP Status Code 200: OK.
BrokerSummaries (list) --
A list of information about all brokers.
(dict) --
Returns information about all brokers.
BrokerArn (string) --
The broker's Amazon Resource Name (ARN).
BrokerId (string) --
The unique ID that Amazon MQ generates for the broker.
BrokerName (string) --
The broker's name. This value is unique in your AWS account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
BrokerState (string) --
The broker's status.
Created (datetime) --
The time when the broker was created.
DeploymentMode (string) --
The broker's deployment mode.
EngineType (string) --
The type of broker engine.
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.
Exceptions
MQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionlist_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'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the configuration.
dict
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.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionlist_configurations(**kwargs)¶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
(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.
AuthenticationStrategy (string) --
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
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. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
EngineVersion (string) --
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines .
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.
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.
Exceptions
MQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionLists tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource tag.
{
'Tags': {
'string': 'string'
}
}
Response Structure
HTTP Status Code 200: OK.
The key-value pair for the resource tag.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionlist_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'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
dict
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. Does not apply to RabbitMQ brokers.
(dict) --
Returns a list of all broker users. Does not apply to RabbitMQ brokers.
PendingChange (string) --
The type of change pending for the broker user.
Username (string) --
Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionreboot_broker(**kwargs)¶Reboots a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.reboot_broker(
BrokerId='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
{}
Response Structure
HTTP Status Code 200: OK.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ForbiddenExceptionupdate_broker(**kwargs)¶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
},
MaintenanceWindowStartTime={
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
SecurityGroups=[
'string',
]
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
A list of information about the configuration.
Required. The unique ID that Amazon MQ generates for the configuration.
The revision number of the configuration.
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
The directory search scope for the role. If set to true, scope is to search the entire subtree.
Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
Specifies the name of the LDAP attribute for the user group membership.
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
The directory search scope for the user. If set to true, scope is to search the entire subtree.
Enables Amazon CloudWatch logging for brokers.
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
Enables general logging.
The parameters that determine the WeeklyStartTime.
Required. The day of the week.
Required. The time, in 24-hour format.
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
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
},
'MaintenanceWindowStartTime': {
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
'SecurityGroups': [
'string',
]
}
Response Structure
(dict) --
HTTP Status Code 200: OK.
AuthenticationStrategy (string) --
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
AutoMinorVersionUpgrade (boolean) --
The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.
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 broker engine version to upgrade to. For a list of supported engine versions, see Supported engines .
HostInstanceType (string) --
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types .
LdapServerMetadata (dict) --
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
Hosts (list) --
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
RoleBase (string) --
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
RoleName (string) --
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) --
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
RoleSearchSubtree (boolean) --
The directory search scope for the role. If set to true, scope is to search the entire subtree.
ServiceAccountUsername (string) --
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
UserBase (string) --
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
UserRoleName (string) --
Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) --
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
UserSearchSubtree (boolean) --
The directory search scope for the user. If set to true, scope is to search the entire subtree.
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. Does not apply to RabbitMQ brokers.
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.
SecurityGroups (list) --
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptionupdate_configuration(**kwargs)¶Updates the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration(
ConfigurationId='string',
Data='string',
Description='string'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the configuration.
[REQUIRED]
Required. The base64-encoded XML configuration.
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
(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.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptionupdate_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'
)
[REQUIRED]
The unique ID that Amazon MQ generates for the broker.
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.
[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.
dict
Response Syntax
{}
Response Structure
(dict) --
HTTP Status Code 200: OK.
Exceptions
MQ.Client.exceptions.NotFoundExceptionMQ.Client.exceptions.BadRequestExceptionMQ.Client.exceptions.InternalServerErrorExceptionMQ.Client.exceptions.ConflictExceptionMQ.Client.exceptions.ForbiddenExceptionThe available paginators are:
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'
}
)
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'|'CRITICAL_ACTION_REQUIRED',
'Created': datetime(2015, 1, 1),
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ'|'CLUSTER_MULTI_AZ',
'EngineType': 'ACTIVEMQ'|'RABBITMQ',
'HostInstanceType': 'string'
},
],
}
Response Structure
HTTP Status Code 200: OK.
A list of information about all brokers.
Returns information about all brokers.
The broker's Amazon Resource Name (ARN).
The unique ID that Amazon MQ generates for the broker.
The broker's name. This value is unique in your AWS account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
The broker's status.
The time when the broker was created.
The broker's deployment mode.
The type of broker engine.
The broker's instance type.