2018/07/30 - AmazonMQ - 10 updated api methods
Changes Update mq client to latest version
{'Logs': {'Audit': 'boolean', 'General': 'boolean'}}
Creates a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
client.create_broker(
AutoMinorVersionUpgrade=True|False,
BrokerName='string',
Configuration={
'Id': 'string',
'Revision': 123
},
CreatorRequestId='string',
DeploymentMode='SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
EngineType='ACTIVEMQ',
EngineVersion='string',
HostInstanceType='string',
Logs={
'Audit': True|False,
'General': True|False
},
MaintenanceWindowStartTime={
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
PubliclyAccessible=True|False,
SecurityGroups=[
'string',
],
SubnetIds=[
'string',
],
Users=[
{
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'Password': 'string',
'Username': 'string'
},
]
)
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.
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
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.
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.
string
Required. The deployment mode of the broker.
string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
string
Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
string
Required. The broker's instance type.
dict
Enables Amazon CloudWatch logging for brokers.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
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.
boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
list
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
(string) --
list
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
(string) --
list
Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
(dict) -- An ActiveMQ user associated with the broker.
ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups (list) -- The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
(string) --
Password (string) -- Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
Username (string) -- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
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.
{'Created': 'timestamp', 'LatestRevision': {'Created': 'timestamp'}}
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
client.create_configuration(
EngineType='ACTIVEMQ',
EngineVersion='string',
Name='string'
)
string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
string
Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
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.
dict
Response Syntax
{
'Arn': 'string',
'Created': datetime(2015, 1, 1),
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Arn (string) -- Required. The Amazon Resource Name (ARN) of the configuration.
Created (datetime) -- Required. The date and time of the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision (dict) -- The latest revision of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- The description of the configuration revision.
Revision (integer) -- Required. The revision number of the configuration.
Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
{'BrokerInstances': {'IpAddress': 'string'},
'Created': 'timestamp',
'Logs': {'Audit': 'boolean',
'AuditLogGroup': 'string',
'General': 'boolean',
'GeneralLogGroup': 'string',
'Pending': {'Audit': 'boolean', 'General': 'boolean'}}}
Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
client.describe_broker(
BrokerId='string'
)
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
{
'AutoMinorVersionUpgrade': True|False,
'BrokerArn': 'string',
'BrokerId': 'string',
'BrokerInstances': [
{
'ConsoleURL': 'string',
'Endpoints': [
'string',
],
'IpAddress': 'string'
},
],
'BrokerName': 'string',
'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
'Configurations': {
'Current': {
'Id': 'string',
'Revision': 123
},
'History': [
{
'Id': 'string',
'Revision': 123
},
],
'Pending': {
'Id': 'string',
'Revision': 123
}
},
'Created': datetime(2015, 1, 1),
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'HostInstanceType': 'string',
'Logs': {
'Audit': True|False,
'AuditLogGroup': 'string',
'General': True|False,
'GeneralLogGroup': 'string',
'Pending': {
'Audit': True|False,
'General': True|False
}
},
'MaintenanceWindowStartTime': {
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
'PubliclyAccessible': True|False,
'SecurityGroups': [
'string',
],
'SubnetIds': [
'string',
],
'Users': [
{
'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
'Username': 'string'
},
]
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
AutoMinorVersionUpgrade (boolean) -- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.
BrokerInstances (list) -- A list of information about allocated brokers.
(dict) -- Returns information about all brokers.
ConsoleURL (string) -- The URL of the broker's ActiveMQ Web Console.
Endpoints (list) -- The broker's wire-level protocol endpoints.
(string) --
IpAddress (string) -- The IP address of the ENI attached to the broker.
BrokerName (string) -- The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
BrokerState (string) -- The status of the broker.
Configurations (dict) -- The list of all revisions for the specified configuration.
Current (dict) -- The current configuration of the broker.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
History (list) -- The history of configurations applied to the broker.
(dict) -- A list of information about the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
Pending (dict) -- The pending configuration of the broker.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
Created (datetime) -- The time when the broker was created.
DeploymentMode (string) -- Required. The deployment mode of the broker.
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
HostInstanceType (string) -- The broker's instance type.
Logs (dict) -- The list of information about logs currently enabled and pending to be deployed for the specified broker.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
AuditLogGroup (string) -- Location of CloudWatch Log group where audit logs will be sent.
General (boolean) -- Enables general logging.
GeneralLogGroup (string) -- Location of CloudWatch Log group where general logs will be 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.
PubliclyAccessible (boolean) -- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
SecurityGroups (list) -- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
(string) --
SubnetIds (list) -- The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
(string) --
Users (list) -- The list of all ActiveMQ usernames for the specified broker.
(dict) -- Returns a list of all ActiveMQ users.
PendingChange (string) -- The type of change pending for the ActiveMQ user.
Username (string) -- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
{'Created': 'timestamp', 'LatestRevision': {'Created': 'timestamp'}}
Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
client.describe_configuration(
ConfigurationId='string'
)
string
[REQUIRED] The unique ID that Amazon MQ generates for the configuration.
dict
Response Syntax
{
'Arn': 'string',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Arn (string) -- Required. The ARN of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- Required. The description of the configuration.
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- Required. The version of the broker engine.
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.
{'Created': 'timestamp'}
Returns the specified configuration revision for the specified configuration.
See also: AWS API Documentation
Request Syntax
client.describe_configuration_revision(
ConfigurationId='string',
ConfigurationRevision='string'
)
string
[REQUIRED] The unique ID that Amazon MQ generates for the configuration.
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.
{'BrokerSummaries': {'Created': 'timestamp'}}
Returns a list of all brokers.
See also: AWS API Documentation
Request Syntax
client.list_brokers(
MaxResults=123,
NextToken='string'
)
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.
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',
'HostInstanceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
BrokerSummaries (list) -- A list of information about all brokers.
(dict) -- The Amazon Resource Name (ARN) of the broker.
BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.
BrokerName (string) -- The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
BrokerState (string) -- The status of the broker.
Created (datetime) -- The time when the broker was created.
DeploymentMode (string) -- Required. The deployment mode of the broker.
HostInstanceType (string) -- The broker's instance type.
NextToken (string) -- The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
{'Revisions': {'Created': 'timestamp'}}
Returns a list of all revisions for the specified configuration.
See also: AWS API Documentation
Request Syntax
client.list_configuration_revisions(
ConfigurationId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED] The unique ID that Amazon MQ generates for the configuration.
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.
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.
{'Configurations': {'Created': 'timestamp',
'LatestRevision': {'Created': 'timestamp'}}}
Returns a list of all configurations.
See also: AWS API Documentation
Request Syntax
client.list_configurations(
MaxResults=123,
NextToken='string'
)
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.
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',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string'
},
],
'MaxResults': 123,
'NextToken': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Configurations (list) -- The list of all revisions for the specified configuration.
(dict) -- Returns information about all configurations.
Arn (string) -- Required. The ARN of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- Required. The description of the configuration.
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- Required. The version of the broker engine.
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.
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.
{'Logs': {'Audit': 'boolean', 'General': 'boolean'}}
Adds a pending configuration change to a broker.
See also: AWS API Documentation
Request Syntax
client.update_broker(
BrokerId='string',
Configuration={
'Id': 'string',
'Revision': 123
},
Logs={
'Audit': True|False,
'General': True|False
}
)
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
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.
dict
Enables Amazon CloudWatch logging for brokers.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
dict
Response Syntax
{
'BrokerId': 'string',
'Configuration': {
'Id': 'string',
'Revision': 123
},
'Logs': {
'Audit': True|False,
'General': True|False
}
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
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.
Logs (dict) -- The list of information about logs to be enabled for the specified broker.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
{'Created': 'timestamp', 'LatestRevision': {'Created': 'timestamp'}}
Updates the specified configuration.
See also: AWS API Documentation
Request Syntax
client.update_configuration(
ConfigurationId='string',
Data='string',
Description='string'
)
string
[REQUIRED] The unique ID that Amazon MQ generates for the configuration.
string
Required. The base64-encoded XML configuration.
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.