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.:
client = session.create_client('mq')
These are the available methods:
can_paginate
(operation_name)¶Check if an operation can be paginated.
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")
.
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(
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'
},
]
)
AuthenticationStrategy (string) – The authentication strategy used to secure the broker.
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.
EncryptionOptions (dict) –
Encryption options for the broker.
KmsKeyId (string) – The symmetric 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.
UseAwsOwnedKey (boolean) – [REQUIRED] Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
EngineType (string) – Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
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.
LdapServerMetadata (dict) –
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) – Fully qualified domain name of the LDAP server. Optional failover server.
(string) –
RoleBase (string) – Fully qualified name of the directory to search for a user’s groups.
RoleName (string) – Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) – The search criteria for groups.
RoleSearchSubtree (boolean) – The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountPassword (string) – Service account password.
ServiceAccountUsername (string) – Service account username.
UserBase (string) – Fully qualified name of the directory where you want to search for users.
UserRoleName (string) – Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) – The search criteria for users.
UserSearchSubtree (boolean) – The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
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. 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.
PubliclyAccessible (boolean) – Required. Enables connections from applications outside of the VPC that hosts the broker’s subnets.
SecurityGroups (list) –
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) –
StorageType (string) – The broker’s storage type.
SubnetIds (list) –
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.
(string) –
Tags (dict) –
Create tags when creating the broker.
(string) –
(string) –
Users (list) –
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) – A user associated with the broker.
ConsoleAccess (boolean) – Enables access to the ActiveMQ Web Console for the ActiveMQ user (Does not apply to RabbitMQ brokers).
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 broker 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 broker user. 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
(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.
Exceptions
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(
AuthenticationStrategy='SIMPLE'|'LDAP',
EngineType='ACTIVEMQ'|'RABBITMQ',
EngineVersion='string',
Name='string',
Tags={
'string': 'string'
}
)
AuthenticationStrategy (string) – The authentication strategy associated with the configuration.
EngineType (string) – Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
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) –
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) – The authentication strategy associated with 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.
Exceptions
Add a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
ResourceArn='string',
Tags={
'string': 'string'
}
)
ResourceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
Tags (dict) –
The key-value pair for the resource tag.
(string) –
(string) –
None
Exceptions
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'
)
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.
dict
Response Syntax
{}
Response Structure
(dict) – HTTP Status Code 200: OK.
Exceptions
delete_broker
(**kwargs)¶Deletes a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.delete_broker(
BrokerId='string'
)
BrokerId (string) – [REQUIRED] The unique ID that Amazon MQ generates for the broker.
dict
Response Syntax
{
'BrokerId': 'string'
}
Response Structure
(dict) – HTTP Status Code 200: OK.
BrokerId (string) – The unique ID that Amazon MQ generates for the broker.
Exceptions
Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
ResourceArn='string',
TagKeys=[
'string',
]
)
ResourceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
TagKeys (list) –
[REQUIRED] An array of tag keys to delete
(string) –
None
Exceptions
delete_user
(**kwargs)¶Deletes an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
BrokerId='string',
Username='string'
)
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.
dict
Response Syntax
{}
Response Structure
(dict) – HTTP Status Code 200: OK.
Exceptions
describe_broker
(**kwargs)¶Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
response = client.describe_broker(
BrokerId='string'
)
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.
dict
Response Syntax
{
'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
(dict) – HTTP Status Code 200: OK.
AuthenticationStrategy (string) – The authentication strategy used to secure the broker.
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 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. Does not apply to RabbitMQ brokers
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.
Warning
Does not apply to RabbitMQ brokers.
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.
EncryptionOptions (dict) – Encryption options for the broker.
KmsKeyId (string) – The symmetric 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.
UseAwsOwnedKey (boolean) – Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
EngineType (string) – Required. The type of broker engine. Note: Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
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.
LdapServerMetadata (dict) – The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) – Fully qualified domain name of the LDAP server. Optional failover server.
(string) –
RoleBase (string) – Fully qualified name of the directory to search for a user’s groups.
RoleName (string) – Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) – The search criteria for groups.
RoleSearchSubtree (boolean) – The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) – Service account username.
UserBase (string) – Fully qualified name of the directory where you want to search for users.
UserRoleName (string) – Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) – The search criteria for users.
UserSearchSubtree (boolean) – The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
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.
PendingAuthenticationStrategy (string) – The authentication strategy that will be applied when the broker is rebooted.
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
PendingHostInstanceType (string) – The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
PendingLdapServerMetadata (dict) – The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
Hosts (list) – Fully qualified domain name of the LDAP server. Optional failover server.
(string) –
RoleBase (string) – Fully qualified name of the directory to search for a user’s groups.
RoleName (string) – Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) – The search criteria for groups.
RoleSearchSubtree (boolean) – The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) – Service account username.
UserBase (string) – Fully qualified name of the directory where you want to search for users.
UserRoleName (string) – Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) – The search criteria for users.
UserSearchSubtree (boolean) – The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
PendingSecurityGroups (list) – The list of pending security groups to authorize connections to brokers.
(string) –
PubliclyAccessible (boolean) – Required. Enables connections from applications outside of the VPC that hosts the broker’s subnets.
SecurityGroups (list) – The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) –
StorageType (string) – The broker’s storage type.
SubnetIds (list) – 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.
(string) –
Tags (dict) – The list of all tags associated with this broker.
(string) –
(string) –
Users (list) – The list of all broker usernames for the specified broker.
(dict) – Returns a list of all broker users.
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
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'
)
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.
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 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.
Exceptions
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',
StorageType='string'
)
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.
StorageType (string) – Filter response by storage type.
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 type of broker engine.
HostInstanceType (string) – The type of broker instance.
StorageType (string) – The broker’s storage type.
SupportedDeploymentModes (list) – The list of supported deployment modes.
(string) – The deployment mode of the broker.
SupportedEngineVersions (list) – The list of supported engine versions.
(string) –
MaxResults (integer) – Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
NextToken (string) – The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Exceptions
describe_configuration
(**kwargs)¶Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration(
ConfigurationId='string'
)
ConfigurationId (string) – [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
dict
Response Syntax
{
'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
(dict) – HTTP Status Code 200: OK.
Arn (string) – Required. The ARN of the configuration.
AuthenticationStrategy (string) – The authentication strategy associated with 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 ACTIVEMQ and RABBITMQ.
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) –
Exceptions
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'
)
ConfigurationId (string) – [REQUIRED] The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision (string) – [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
describe_user
(**kwargs)¶Returns information about an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
BrokerId='string',
Username='string'
)
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.
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.
(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.
Exceptions
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
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.
The presigned url
get_paginator
(operation_name)¶Create a paginator for an operation.
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")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
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'
)
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.
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
(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.
EngineType (string) – Required. 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
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'
)
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.
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
list_configurations
(**kwargs)¶Returns a list of all configurations.
See also: AWS API Documentation
Request Syntax
response = client.list_configurations(
MaxResults=123,
NextToken='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.
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) – The authentication strategy associated with 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 ACTIVEMQ and RABBITMQ.
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.
Exceptions
Lists tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceArn='string'
)
ResourceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the resource tag.
dict
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) –
Exceptions
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'
)
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.
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.
(dict) – Returns a list of all broker users.
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
reboot_broker
(**kwargs)¶Reboots a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.reboot_broker(
BrokerId='string'
)
BrokerId (string) – [REQUIRED] The unique ID that Amazon MQ generates for the broker.
dict
Response Syntax
{}
Response Structure
(dict) – HTTP Status Code 200: OK.
Exceptions
update_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
},
SecurityGroups=[
'string',
]
)
AuthenticationStrategy (string) – The authentication strategy used to secure the broker.
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 unique ID that Amazon MQ generates for the broker.
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
HostInstanceType (string) – The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
LdapServerMetadata (dict) –
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) – Fully qualified domain name of the LDAP server. Optional failover server.
(string) –
RoleBase (string) – Fully qualified name of the directory to search for a user’s groups.
RoleName (string) – Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) – The search criteria for groups.
RoleSearchSubtree (boolean) – The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountPassword (string) – Service account password.
ServiceAccountUsername (string) – Service account username.
UserBase (string) – Fully qualified name of the directory where you want to search for users.
UserRoleName (string) – Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) – The search criteria for users.
UserSearchSubtree (boolean) – The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
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. Does not apply to RabbitMQ brokers.
General (boolean) – Enables general logging.
SecurityGroups (list) –
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) –
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
(dict) – HTTP Status Code 200: OK.
AuthenticationStrategy (string) – The authentication strategy used to secure the broker.
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
HostInstanceType (string) – The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
LdapServerMetadata (dict) – The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) – Fully qualified domain name of the LDAP server. Optional failover server.
(string) –
RoleBase (string) – Fully qualified name of the directory to search for a user’s groups.
RoleName (string) – Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) – The search criteria for groups.
RoleSearchSubtree (boolean) – The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) – Service account username.
UserBase (string) – Fully qualified name of the directory where you want to search for users.
UserRoleName (string) – Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) – The search criteria for users.
UserSearchSubtree (boolean) – The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
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.
SecurityGroups (list) – The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) –
Exceptions
update_configuration
(**kwargs)¶Updates the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration(
ConfigurationId='string',
Data='string',
Description='string'
)
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.
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
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'
)
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.
dict
Response Syntax
{}
Response Structure
(dict) – HTTP Status Code 200: OK.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
MQ.Client.exceptions.
BadRequestException
¶Returns information about an error.
Example
try:
...
except client.exceptions.BadRequestException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
MQ.Client.exceptions.
ConflictException
¶Returns information about an error.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
MQ.Client.exceptions.
ForbiddenException
¶Returns information about an error.
Example
try:
...
except client.exceptions.ForbiddenException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
MQ.Client.exceptions.
InternalServerErrorException
¶Returns information about an error.
Example
try:
...
except client.exceptions.InternalServerErrorException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
MQ.Client.exceptions.
NotFoundException
¶Returns information about an error.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
Returns information about an error.
Example
try:
...
except client.exceptions.UnauthorizedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'ErrorAttribute': 'string',
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) – Returns information about an error.
ErrorAttribute (string) – The attribute which caused the error.
Message (string) – The explanation of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The 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'
}
)
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.
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'
},
],
}
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.
EngineType (string) – Required. The type of broker engine.
HostInstanceType (string) – The broker’s instance type.