Amazon MQ
REST API Reference

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

Returns information about the specified configuration.

Path

Name Type Description

configuration-id

string

The unique ID that Amazon MQ generates for the configuration.

Response

Status Code Schema Description

200

Configuration

HTTP Status Code 200: OK.

PUT

Updates the specified configuration.

Body

Name Type Description

UpdateConfigurationInput

UpdateConfigurationInput

Updates the specified configuration.

Path

Name Type Description

configuration-id

string

The unique ID that Amazon MQ generates for the configuration.

Response

Status Code Schema Description

200

UpdateConfigurationOutput

HTTP Status Code 200: OK.

Errors

Errors

Status Code Schema Description

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. Concurrent update to configuration. Retry to create a new revision.

500

Error

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

Schemas

Request Schemas

Example UpdateConfigurationInput

{ "description": "My basic configuration for working with an ActiveMQ broker.", "data": "lciEXAMPLEB4bWxucz0iaHR0cDovL2FjdGl2ZW1xLmFwYWNoZS5vcmcvc2NoZW1hL2NvcmUiCiAgICAgICAgeHNpOnNjaGVtYUxvY2F0aW9uPSJodHRwOi8vYWN0aXZlbXEuYXBhY2hlLm9yZy9zY2hlbWEvY29yZSBodHRwOi8vYWN0aXZlbXEuYXBhY2hlLm9yZy9zY2hlbWEvY29yZS9hY3RpdmVtcS1jb3JlLnhzZCIKICAgICAgICB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIj4KCjwvYnJva2VyPgo" }

Response Schemas

Example Configuration

{ "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "name": "MyConfiguration", "arn": "arn:aws:mq:us-east-2:123456789012:configuration:MyConfiguration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "engineType": "ActiveMQ", "engineVersion": "5.15.6", "description": "My basic configuration for working with an ActiveMQ broker.", "created": "2017-11-28T01:23:45.678Z", "latestRevision": { "revision": 3, "description": "This is the third revision of the configuration. It improves application functionality.", "created": "2017-11-28T01:23:45.678Z" } }

Example UpdateConfigurationOutput

{ "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "name": "MyConfiguration", "arn": "arn:aws:mq:us-east-2:123456789012:configuration:MyConfiguration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "created": "2017-11-28T01:23:45.678Z", "latestRevision": { "revision": 4, "description": "This is the fourth revision of the configuration. It improves application functionality.", "created": "2017-11-29T01:23:45.678Z" }, "warnings": [{ "elementName": "broker", "attributeName": "attrib", "reason": "DISALLOWED_ATTRIBUTE_REMOVED" }, { "elementName": "broker", "attributeName": "schemaLocation", "reason": "DISALLOWED_ATTRIBUTE_REMOVED" }, { "elementName": "element", "reason": "DISALLOWED_ELEMENT_REMOVED" }] }

Example Error

{ "errorAttribute": "TheAttributeWhichCausedTheError", "message": "This is the description of the error and the steps to resolve the issue." }

Attributes

UpdateConfigurationInput

Attribute Type Description

data

string (byte)

Required

The base64-encoded XML configuration.

description

string

The description of the configuration.

Configuration

Attribute Type Description

arn

string

Required

The ARN of the configuration.

created

string (date-time)

Required

The date and time of the configuration revision.

description

string

Required

The description of the configuration.

engineType

enum

Required

The type of broker engine.

Note

Currently, Amazon MQ supports only ACTIVEMQ.

engineVersion

enum

Required

The version of the broker engine.

id

string

Required

The unique ID that Amazon MQ generates for the configuration.

latestRevision

ConfigurationRevision

Required

The latest revision 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.

ConfigurationRevision

Attribute Type Description

created

string (date-time)

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.

UpdateConfigurationOutput

Attribute Type Description

arn

string

Required

The Amazon Resource Name (ARN) of the configuration.

created

string (date-time)

Required

The date and time of the configuration.

id

string

Required

The unique ID that Amazon MQ generates for the configuration.

latestRevision

ConfigurationRevision

The latest revision 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

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

SanitizationWarning

Attribute Type Description

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

enum

Required

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

Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED

DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.