A low-level client representing AmazonMQ:
client = session.create_client('mq')
These are the available methods:
Check if an operation can be paginated.
Creates a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.create_broker(
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',
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'
},
]
)
A list of information about the configuration.
The parameters that determine the WeeklyStartTime.
Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
Required. 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.
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
Response Syntax
{
'BrokerArn': 'string',
'BrokerId': 'string'
}
Response Structure
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration.
See also: AWS API Documentation
Request Syntax
response = client.create_configuration(
EngineType='ACTIVEMQ',
EngineVersion='string',
Name='string'
)
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'LatestRevision': {
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
Creates an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
BrokerId='string',
ConsoleAccess=True|False,
Groups=[
'string',
],
Password='string',
Username='string'
)
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
dict
Response Syntax
{}
Response Structure
Deletes a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.delete_broker(
BrokerId='string'
)
{
'BrokerId': 'string'
}
Response Structure
Deletes an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
BrokerId='string',
Username='string'
)
dict
Response Syntax
{}
Response Structure
Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
response = client.describe_broker(
BrokerId='string'
)
{
'AutoMinorVersionUpgrade': True|False,
'BrokerArn': 'string',
'BrokerId': 'string',
'BrokerInstances': [
{
'ConsoleURL': 'string',
'Endpoints': [
'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
}
},
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'HostInstanceType': 'string',
'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
Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration(
ConfigurationId='string'
)
{
'Arn': 'string',
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
Returns the specified configuration revision for the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration_revision(
ConfigurationId='string',
ConfigurationRevision='string'
)
dict
Response Syntax
{
'ConfigurationId': 'string',
'Data': 'string',
'Description': 'string'
}
Response Structure
Returns information about an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
BrokerId='string',
Username='string'
)
dict
Response Syntax
{
'BrokerId': 'string',
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'Pending': {
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'PendingChange': 'CREATE'|'UPDATE'|'DELETE'
},
'Username': 'string'
}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns a list of all brokers.
See also: AWS API Documentation
Request Syntax
response = client.list_brokers(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'BrokerSummaries': [
{
'BrokerArn': 'string',
'BrokerId': 'string',
'BrokerName': 'string',
'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
'HostInstanceType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Returns a list of all revisions for the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.list_configuration_revisions(
ConfigurationId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ConfigurationId': 'string',
'MaxResults': 123,
'NextToken': 'string',
'Revisions': [
{
'Description': 'string',
'Revision': 123
},
]
}
Response Structure
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',
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Description': 'string',
'Revision': 123
},
'Name': 'string'
},
],
'MaxResults': 123,
'NextToken': 'string'
}
Response Structure
Returns a list of all ActiveMQ users.
See also: AWS API Documentation
Request Syntax
response = client.list_users(
BrokerId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'BrokerId': 'string',
'MaxResults': 123,
'NextToken': 'string',
'Users': [
{
'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
'Username': 'string'
},
]
}
Response Structure
Reboots a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
response = client.reboot_broker(
BrokerId='string'
)
{}
Response Structure
Adds a pending configuration change to a broker.
See also: AWS API Documentation
Request Syntax
response = client.update_broker(
BrokerId='string',
Configuration={
'Id': 'string',
'Revision': 123
}
)
A list of information about the configuration.
dict
Response Syntax
{
'BrokerId': 'string',
'Configuration': {
'Id': 'string',
'Revision': 123
}
}
Response Structure
Updates the specified configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_configuration(
ConfigurationId='string',
Data='string',
Description='string'
)
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'LatestRevision': {
'Description': 'string',
'Revision': 123
},
'Name': 'string',
'Warnings': [
{
'AttributeName': 'string',
'ElementName': 'string',
'Reason': 'DISALLOWED_ELEMENT_REMOVED'|'DISALLOWED_ATTRIBUTE_REMOVED'|'INVALID_ATTRIBUTE_VALUE_REMOVED'
},
]
}
Response Structure
Updates the information for an ActiveMQ user.
See also: AWS API Documentation
Request Syntax
response = client.update_user(
BrokerId='string',
ConsoleAccess=True|False,
Groups=[
'string',
],
Password='string',
Username='string'
)
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
dict
Response Syntax
{}
Response Structure