Amazon MQ
REST API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Configuration

A configuration contains all of the settings for your ActiveMQ broker, in XML format. For more information, see Configuration and Amazon MQ Broker Configuration Parameters in the Amazon MQ Developer Guide.

You can create a configuration before creating any brokers. You can then apply the configuration to one or more brokers.

Important

Making changes to a configuration does not apply the changes to the broker immediately. To apply your changes, you must wait for the next maintenance window or reboot the broker.

URI

/v1/configurations/configuration-id

HTTP Methods

GET

Operation ID: DescribeConfiguration

Returns information about the specified configuration.

Path Parameters

Name Type Required Description
configuration-id String True

The unique ID that Amazon MQ generates for the configuration.

Responses

Status Code Response Model Description
200 Configuration

HTTP Status Code 200: OK.

400 Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403 Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404 Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

500 Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

PUT

Operation ID: UpdateConfiguration

Updates the specified configuration.

Path Parameters

Name Type Required Description
configuration-id String True

The unique ID that Amazon MQ generates for the configuration.

Responses

Status Code Response Model Description
200 UpdateConfigurationOutput

HTTP Status Code 200: OK.

400 Error

HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

403 Error

HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

404 Error

HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

409 Error

HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.

500 Error

HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Schemas

Request Bodies

Example PUT

{ "data": "string", "description": "string" }

Response Bodies

Example Configuration

{ "engineVersion": "string", "created": "string", "name": "string", "description": "string", "engineType": enum, "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer }, "tags": { } }

Example UpdateConfigurationOutput

{ "created": "string", "warnings": [ { "reason": enum, "attributeName": "string", "elementName": "string" } ], "name": "string", "id": "string", "arn": "string", "latestRevision": { "created": "string", "description": "string", "revision": integer } }

Example Error

{ "errorAttribute": "string", "message": "string" }

Properties

Configuration

Returns information about all configurations.

Property Type Required Description
engineVersion

string

False

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

created

string

Format: date-time

False

Required. The date and time of the configuration revision.

name

string

False

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.

description

string

False

Required. The description of the configuration.

engineType

EngineType

False

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

id

string

False

Required. The unique ID that Amazon MQ generates for the configuration.

arn

string

False

Required. The ARN of the configuration.

latestRevision

ConfigurationRevision

False

Required. The latest revision of the configuration.

tags

object

False

The list of all tags associated with this configuration.

ConfigurationRevision

Returns information about the specified configuration revision.

Property Type Required Description
created

string

Format: date-time

False

Required. The date and time of the configuration revision.

description

string

False

The description of the configuration revision.

revision

integer

False

Required. The revision number of the configuration.

EngineType

The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

  • ACTIVEMQ

Error

Returns information about an error.

Property Type Required Description
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

SanitizationWarning

Returns information about the XML element or attribute that was sanitized in the configuration.

Property Type Required Description
reason

SanitizationWarningReason

False

Required. The reason for which the XML elements or attributes were sanitized.

attributeName

string

False

The name of the XML attribute that has been sanitized.

elementName

string

False

The name of the XML element that has been sanitized.

SanitizationWarningReason

The reason for which the XML elements or attributes were sanitized.

  • DISALLOWED_ELEMENT_REMOVED

  • DISALLOWED_ATTRIBUTE_REMOVED

  • INVALID_ATTRIBUTE_VALUE_REMOVED

UpdateConfigurationInput

Updates the specified configuration.

Property Type Required Description
data

string

Format: byte

False

Required. The base64-encoded XML configuration.

description

string

False

The description of the configuration.

UpdateConfigurationOutput

Returns information about the updated configuration.

Property Type Required Description
created

string

Format: date-time

False

Required. The date and time of the configuration.

warnings

Array of type SanitizationWarning

False

The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.

name

string

False

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.

id

string

False

Required. The unique ID that Amazon MQ generates for the configuration.

arn

string

False

Required. The Amazon Resource Name (ARN) of the configuration.

latestRevision

ConfigurationRevision

False

The latest revision of the configuration.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeConfiguration

UpdateConfiguration