Class: AWS.MQ

Inherits:

AWS.Service

Object
AWS.Service
AWS.MQ

show all

Identifier:: mq

API Version:: 2017-11-27

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon MQ is a managed message broker service for Apache ActiveMQ 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.

Sending a Request Using MQ

var mq = new AWS.MQ();
mq.createBroker(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MQ object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mq = new AWS.MQ({apiVersion: '2017-11-27'});

You can also set the API version globally in AWS.config.apiVersions using the mq service identifier:

AWS.config.apiVersions = {
  mq: '2017-11-27',
  // other service API versions
};

var mq = new AWS.MQ();

Version:

2017-11-27

Constructor Summary

new AWS.MQ(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

createBroker(params = {}, callback) ⇒ AWS.Request
Creates a broker.
createConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a new configuration for the specified configuration name.
createTags(params = {}, callback) ⇒ AWS.Request
Add a tag to a resource.
createUser(params = {}, callback) ⇒ AWS.Request
Creates an ActiveMQ user.
deleteBroker(params = {}, callback) ⇒ AWS.Request
Deletes a broker.
deleteTags(params = {}, callback) ⇒ AWS.Request
Removes a tag from a resource.
deleteUser(params = {}, callback) ⇒ AWS.Request
Deletes an ActiveMQ user.
describeBroker(params = {}, callback) ⇒ AWS.Request
Returns information about the specified broker.
describeBrokerEngineTypes(params = {}, callback) ⇒ AWS.Request
Describe available engine types and versions.
describeBrokerInstanceOptions(params = {}, callback) ⇒ AWS.Request
Describe available broker instance options.
describeConfiguration(params = {}, callback) ⇒ AWS.Request
Returns information about the specified configuration.
describeConfigurationRevision(params = {}, callback) ⇒ AWS.Request
Returns the specified configuration revision for the specified configuration.
describeUser(params = {}, callback) ⇒ AWS.Request
Returns information about an ActiveMQ user.
listBrokers(params = {}, callback) ⇒ AWS.Request
Returns a list of all brokers.
listConfigurationRevisions(params = {}, callback) ⇒ AWS.Request
Returns a list of all revisions for the specified configuration.
listConfigurations(params = {}, callback) ⇒ AWS.Request
Returns a list of all configurations.
listTags(params = {}, callback) ⇒ AWS.Request
Lists tags for a resource.
listUsers(params = {}, callback) ⇒ AWS.Request
Returns a list of all ActiveMQ users.
rebootBroker(params = {}, callback) ⇒ AWS.Request
Reboots a broker.
updateBroker(params = {}, callback) ⇒ AWS.Request
Adds a pending configuration change to a broker.
updateConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the specified configuration.
updateUser(params = {}, callback) ⇒ AWS.Request
Updates the information for an ActiveMQ user.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MQ(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MQ object

var mq = new AWS.MQ({apiVersion: '2017-11-27'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.MQ.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.MQ.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.MQ.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean) —
whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

createBroker(params = {}, callback) ⇒ `AWS.Request`

Creates a broker. Note: This API is asynchronous.

Service Reference:

CreateBroker

Examples:

Calling the createBroker operation

var params = {
  AutoMinorVersionUpgrade: true || false,
  BrokerName: 'STRING_VALUE',
  Configuration: {
    Id: 'STRING_VALUE',
    Revision: 'NUMBER_VALUE'
  },
  CreatorRequestId: 'STRING_VALUE',
  DeploymentMode: SINGLE_INSTANCE | ACTIVE_STANDBY_MULTI_AZ,
  EngineType: ACTIVEMQ,
  EngineVersion: 'STRING_VALUE',
  HostInstanceType: 'STRING_VALUE',
  Logs: {
    Audit: true || false,
    General: true || false
  },
  MaintenanceWindowStartTime: {
    DayOfWeek: MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY,
    TimeOfDay: 'STRING_VALUE',
    TimeZone: 'STRING_VALUE'
  },
  PubliclyAccessible: true || false,
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  Users: [
    {
      ConsoleAccess: true || false,
      Groups: [
        'STRING_VALUE',
        /* more items */
      ],
      Password: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ]
};
mq.createBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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 — (map) 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. If a token is not provided, the SDK will use a version 4 UUID.
- DeploymentMode — (String) Required. The deployment mode of the broker. Possible values include:
  - "SINGLE_INSTANCE"
  - "ACTIVE_STANDBY_MULTI_AZ"
- EngineType — (String) Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. Possible values include:
  - "ACTIVEMQ"
- 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.
- Logs — (map) 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.
- MaintenanceWindowStartTime — (map) The parameters that determine the WeeklyStartTime.
  - DayOfWeek — (String) Required. The day of the week. Possible values include:
    - "MONDAY"
    - "TUESDAY"
    - "WEDNESDAY"
    - "THURSDAY"
    - "FRIDAY"
    - "SATURDAY"
    - "SUNDAY"
  - 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 — (Array<String>) The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
- SubnetIds — (Array<String>) 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.
- Tags — (map<String>) Create tags when creating the broker.
- Users — (Array<map>) 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.
  - ConsoleAccess — (Boolean) Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
  - Groups — (Array<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.
  - 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - BrokerArn — (String) The Amazon Resource Name (ARN) of the broker.
  - BrokerId — (String) The unique ID that Amazon MQ generates for the broker.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createConfiguration(params = {}, callback) ⇒ `AWS.Request`

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Service Reference:

CreateConfiguration

Examples:

Calling the createConfiguration operation

var params = {
  EngineType: ACTIVEMQ,
  EngineVersion: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mq.createConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- EngineType — (String) Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. Possible values include:
  - "ACTIVEMQ"
- 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 — (map<String>) Create tags when creating the configuration.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String) Required. The Amazon Resource Name (ARN) of the configuration.
  - Created — (Date) Required. The date and time of the configuration.
  - Id — (String) Required. The unique ID that Amazon MQ generates for the configuration.
  - LatestRevision — (map) The latest revision of the configuration.
    
    Created — (Date) 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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createTags(params = {}, callback) ⇒ `AWS.Request`

Add a tag to a resource.

Service Reference:

CreateTags

Examples:

Calling the createTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mq.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String) The Amazon Resource Name (ARN) of the resource tag.
- Tags — (map<String>) The key-value pair for the resource tag.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createUser(params = {}, callback) ⇒ `AWS.Request`

Creates an ActiveMQ user.

Service Reference:

CreateUser

Examples:

Calling the createUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ConsoleAccess: true || false,
  Groups: [
    'STRING_VALUE',
    /* more items */
  ],
  Password: 'STRING_VALUE'
};
mq.createUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) 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 — (Array<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.
- 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) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteBroker(params = {}, callback) ⇒ `AWS.Request`

Deletes a broker. Note: This API is asynchronous.

Service Reference:

DeleteBroker

Examples:

Calling the deleteBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.deleteBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - BrokerId — (String) The unique ID that Amazon MQ generates for the broker.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteTags(params = {}, callback) ⇒ `AWS.Request`

Removes a tag from a resource.

Service Reference:

DeleteTags

Examples:

Calling the deleteTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mq.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String) The Amazon Resource Name (ARN) of the resource tag.
- TagKeys — (Array<String>) An array of tag keys to delete

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteUser(params = {}, callback) ⇒ `AWS.Request`

Deletes an ActiveMQ user.

Service Reference:

DeleteUser

Examples:

Calling the deleteUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
mq.deleteUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) The unique ID that Amazon MQ generates for the broker.
- Username — (String) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeBroker(params = {}, callback) ⇒ `AWS.Request`

Returns information about the specified broker.

Service Reference:

DescribeBroker

Examples:

Calling the describeBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.describeBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - 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 — (Array<map>) A list of information about allocated brokers.
    
    ConsoleURL — (String) The URL of the broker's ActiveMQ Web Console.
    
    Endpoints — (Array<String>) The broker's wire-level protocol endpoints.
    
    IpAddress — (String) The IP address of the Elastic Network Interface (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. Possible values include:
    
    "CREATION_IN_PROGRESS"
    
    "CREATION_FAILED"
    
    "DELETION_IN_PROGRESS"
    
    "RUNNING"
    
    "REBOOT_IN_PROGRESS"
  - Configurations — (map) The list of all revisions for the specified configuration.
    
    Current — (map) 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 — (Array<map>) The history of configurations applied to the broker.
    
    Id — (String) Required. The unique ID that Amazon MQ generates for the configuration.
    
    Revision — (Integer) The revision number of the configuration.
    
    Pending — (map) 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 — (Date) The time when the broker was created.
  - DeploymentMode — (String) Required. The deployment mode of the broker. Possible values include:
    
    "SINGLE_INSTANCE"
    
    "ACTIVE_STANDBY_MULTI_AZ"
  - EngineType — (String) Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ. Possible values include:
    
    "ACTIVEMQ"
  - 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.
  - Logs — (map) 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 — (map) 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 — (map) The parameters that determine the WeeklyStartTime.
    
    DayOfWeek — (String) Required. The day of the week. Possible values include:
    
    "MONDAY"
    
    "TUESDAY"
    
    "WEDNESDAY"
    
    "THURSDAY"
    
    "FRIDAY"
    
    "SATURDAY"
    
    "SUNDAY"
    
    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.
  - 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
  - PubliclyAccessible — (Boolean) Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - SecurityGroups — (Array<String>) Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - SubnetIds — (Array<String>) 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.
  - Tags — (map<String>) The list of all tags associated with this broker.
  - Users — (Array<map>) The list of all ActiveMQ usernames for the specified broker.
    
    PendingChange — (String) The type of change pending for the ActiveMQ user. Possible values include:
    
    "CREATE"
    
    "UPDATE"
    
    "DELETE"
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeBrokerEngineTypes(params = {}, callback) ⇒ `AWS.Request`

Describe available engine types and versions.

Service Reference:

DescribeBrokerEngineTypes

Examples:

Calling the describeBrokerEngineTypes operation

var params = {
  EngineType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.describeBrokerEngineTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - BrokerEngineTypes — (Array<map>) List of available engine types and versions.
    
    EngineType — (String) The type of broker engine. Possible values include:
    
    "ACTIVEMQ"
    
    EngineVersions — (Array<map>) The list of engine versions.
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeBrokerInstanceOptions(params = {}, callback) ⇒ `AWS.Request`

Describe available broker instance options.

Service Reference:

DescribeBrokerInstanceOptions

Examples:

Calling the describeBrokerInstanceOptions operation

var params = {
  EngineType: 'STRING_VALUE',
  HostInstanceType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.describeBrokerInstanceOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - BrokerInstanceOptions — (Array<map>) List of available broker instance options.
    
    AvailabilityZones — (Array<map>) The list of available az.
    
    Name — (String) Id for the availability zone.
    
    EngineType — (String) The type of broker engine. Possible values include:
    
    "ACTIVEMQ"
    
    HostInstanceType — (String) The type of broker instance.
    
    SupportedEngineVersions — (Array<String>) The list of supported engine versions.
  - MaxResults — (Integer) Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
  - NextToken — (String) The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeConfiguration(params = {}, callback) ⇒ `AWS.Request`

Returns information about the specified configuration.

Service Reference:

DescribeConfiguration

Examples:

Calling the describeConfiguration operation

var params = {
  ConfigurationId: 'STRING_VALUE' /* required */
};
mq.describeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ConfigurationId — (String) The unique ID that Amazon MQ generates for the configuration.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String) Required. The ARN of the configuration.
  - Created — (Date) 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. Possible values include:
    
    "ACTIVEMQ"
  - 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 — (map) Required. The latest revision of the configuration.
    
    Created — (Date) 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 — (map<String>) The list of all tags associated with this configuration.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeConfigurationRevision(params = {}, callback) ⇒ `AWS.Request`

Returns the specified configuration revision for the specified configuration.

Service Reference:

DescribeConfigurationRevision

Examples:

Calling the describeConfigurationRevision operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  ConfigurationRevision: 'STRING_VALUE' /* required */
};
mq.describeConfigurationRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ConfigurationId — (String) The unique ID that Amazon MQ generates for the configuration.
- ConfigurationRevision — (String) The revision of the configuration.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ConfigurationId — (String) Required. The unique ID that Amazon MQ generates for the configuration.
  - Created — (Date) Required. The date and time of the configuration.
  - Data — (String) Required. The base64-encoded XML configuration.
  - Description — (String) The description of the configuration.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeUser(params = {}, callback) ⇒ `AWS.Request`

Returns information about an ActiveMQ user.

Service Reference:

DescribeUser

Examples:

Calling the describeUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE' /* required */
};
mq.describeUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) The unique ID that Amazon MQ generates for the broker.
- Username — (String) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - 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 — (Array<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.
  - Pending — (map) 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 — (Array<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.
    
    PendingChange — (String) Required. The type of change pending for the ActiveMQ user. Possible values include:
    
    "CREATE"
    
    "UPDATE"
    
    "DELETE"
  - 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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listBrokers(params = {}, callback) ⇒ `AWS.Request`

Returns a list of all brokers.

Service Reference:

ListBrokers

Examples:

Calling the listBrokers operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listBrokers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - BrokerSummaries — (Array<map>) A list of information about all brokers.
    
    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. Possible values include:
    
    "CREATION_IN_PROGRESS"
    
    "CREATION_FAILED"
    
    "DELETION_IN_PROGRESS"
    
    "RUNNING"
    
    "REBOOT_IN_PROGRESS"
    
    Created — (Date) The time when the broker was created.
    
    DeploymentMode — (String) Required. The deployment mode of the broker. Possible values include:
    
    "SINGLE_INSTANCE"
    
    "ACTIVE_STANDBY_MULTI_AZ"
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listConfigurationRevisions(params = {}, callback) ⇒ `AWS.Request`

Returns a list of all revisions for the specified configuration.

Service Reference:

ListConfigurationRevisions

Examples:

Calling the listConfigurationRevisions operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listConfigurationRevisions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ConfigurationId — (String) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - 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 — (Array<map>) The list of all revisions for the specified configuration.
    
    Created — (Date) 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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listConfigurations(params = {}, callback) ⇒ `AWS.Request`

Returns a list of all configurations.

Service Reference:

ListConfigurations

Examples:

Calling the listConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Configurations — (Array<map>) The list of all revisions for the specified configuration.
    
    Arn — (String) Required. The ARN of the configuration.
    
    Created — (Date) 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. Possible values include:
    
    "ACTIVEMQ"
    
    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 — (map) Required. The latest revision of the configuration.
    
    Created — (Date) 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 — (map<String>) The list of all tags associated with this configuration.
  - MaxResults — (Integer) The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
  - NextToken — (String) The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Lists tags for a resource.

Service Reference:

ListTags

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mq.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String) The Amazon Resource Name (ARN) of the resource tag.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Tags — (map<String>) The key-value pair for the resource tag.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listUsers(params = {}, callback) ⇒ `AWS.Request`

Returns a list of all ActiveMQ users.

Service Reference:

ListUsers

Examples:

Calling the listUsers operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mq.listUsers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - 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 — (Array<map>) Required. The list of all ActiveMQ usernames for the specified broker.
    
    PendingChange — (String) The type of change pending for the ActiveMQ user. Possible values include:
    
    "CREATE"
    
    "UPDATE"
    
    "DELETE"
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

rebootBroker(params = {}, callback) ⇒ `AWS.Request`

Reboots a broker. Note: This API is asynchronous.

Service Reference:

RebootBroker

Examples:

Calling the rebootBroker operation

var params = {
  BrokerId: 'STRING_VALUE' /* required */
};
mq.rebootBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) The unique ID that Amazon MQ generates for the broker.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateBroker(params = {}, callback) ⇒ `AWS.Request`

Adds a pending configuration change to a broker.

Service Reference:

UpdateBroker

Examples:

Calling the updateBroker operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  AutoMinorVersionUpgrade: true || false,
  Configuration: {
    Id: 'STRING_VALUE',
    Revision: 'NUMBER_VALUE'
  },
  EngineVersion: 'STRING_VALUE',
  Logs: {
    Audit: true || false,
    General: true || false
  }
};
mq.updateBroker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- 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) 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 — (map) 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
- Logs — (map) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - 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 — (map) 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
  - Logs — (map) 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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateConfiguration(params = {}, callback) ⇒ `AWS.Request`

Updates the specified configuration.

Service Reference:

UpdateConfiguration

Examples:

Calling the updateConfiguration operation

var params = {
  ConfigurationId: 'STRING_VALUE', /* required */
  Data: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
mq.updateConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ConfigurationId — (String) 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String) Required. The Amazon Resource Name (ARN) of the configuration.
  - Created — (Date) Required. The date and time of the configuration.
  - Id — (String) Required. The unique ID that Amazon MQ generates for the configuration.
  - LatestRevision — (map) The latest revision of the configuration.
    
    Created — (Date) 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 — (Array<map>) The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.
    
    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. Possible values include:
    
    "DISALLOWED_ELEMENT_REMOVED"
    
    "DISALLOWED_ATTRIBUTE_REMOVED"
    
    "INVALID_ATTRIBUTE_VALUE_REMOVED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateUser(params = {}, callback) ⇒ `AWS.Request`

Updates the information for an ActiveMQ user.

Service Reference:

UpdateUser

Examples:

Calling the updateUser operation

var params = {
  BrokerId: 'STRING_VALUE', /* required */
  Username: 'STRING_VALUE', /* required */
  ConsoleAccess: true || false,
  Groups: [
    'STRING_VALUE',
    /* more items */
  ],
  Password: 'STRING_VALUE'
};
mq.updateUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- BrokerId — (String) 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 — (Array<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.
- 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. 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.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.MQ

Overview

Service Description

Sending a Request Using MQ

Locking the API Version

Constructor Summary

Property Summary

Properties inherited from AWS.Service

Method Summary

Methods inherited from AWS.Service

Constructor Details

new AWS.MQ(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createBroker(params = {}, callback) ⇒ AWS.Request

createConfiguration(params = {}, callback) ⇒ AWS.Request

createTags(params = {}, callback) ⇒ AWS.Request

createUser(params = {}, callback) ⇒ AWS.Request

deleteBroker(params = {}, callback) ⇒ AWS.Request

deleteTags(params = {}, callback) ⇒ AWS.Request

deleteUser(params = {}, callback) ⇒ AWS.Request

describeBroker(params = {}, callback) ⇒ AWS.Request

describeBrokerEngineTypes(params = {}, callback) ⇒ AWS.Request

describeBrokerInstanceOptions(params = {}, callback) ⇒ AWS.Request

describeConfiguration(params = {}, callback) ⇒ AWS.Request

describeConfigurationRevision(params = {}, callback) ⇒ AWS.Request

describeUser(params = {}, callback) ⇒ AWS.Request

listBrokers(params = {}, callback) ⇒ AWS.Request

listConfigurationRevisions(params = {}, callback) ⇒ AWS.Request

listConfigurations(params = {}, callback) ⇒ AWS.Request

listTags(params = {}, callback) ⇒ AWS.Request

listUsers(params = {}, callback) ⇒ AWS.Request

rebootBroker(params = {}, callback) ⇒ AWS.Request

updateBroker(params = {}, callback) ⇒ AWS.Request

updateConfiguration(params = {}, callback) ⇒ AWS.Request

updateUser(params = {}, callback) ⇒ AWS.Request

new AWS.MQ(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createBroker(params = {}, callback) ⇒ `AWS.Request`

createConfiguration(params = {}, callback) ⇒ `AWS.Request`

createTags(params = {}, callback) ⇒ `AWS.Request`

createUser(params = {}, callback) ⇒ `AWS.Request`

deleteBroker(params = {}, callback) ⇒ `AWS.Request`

deleteTags(params = {}, callback) ⇒ `AWS.Request`

deleteUser(params = {}, callback) ⇒ `AWS.Request`

describeBroker(params = {}, callback) ⇒ `AWS.Request`

describeBrokerEngineTypes(params = {}, callback) ⇒ `AWS.Request`

describeBrokerInstanceOptions(params = {}, callback) ⇒ `AWS.Request`

describeConfiguration(params = {}, callback) ⇒ `AWS.Request`

describeConfigurationRevision(params = {}, callback) ⇒ `AWS.Request`

describeUser(params = {}, callback) ⇒ `AWS.Request`

listBrokers(params = {}, callback) ⇒ `AWS.Request`

listConfigurationRevisions(params = {}, callback) ⇒ `AWS.Request`

listConfigurations(params = {}, callback) ⇒ `AWS.Request`

listTags(params = {}, callback) ⇒ `AWS.Request`

listUsers(params = {}, callback) ⇒ `AWS.Request`

rebootBroker(params = {}, callback) ⇒ `AWS.Request`

updateBroker(params = {}, callback) ⇒ `AWS.Request`

updateConfiguration(params = {}, callback) ⇒ `AWS.Request`

updateUser(params = {}, callback) ⇒ `AWS.Request`