Menu
Amazon MQ
REST API Reference

Configuration Revision

To keep track of the changes you make to your configuration, you can create configuration revisions. For more information, see Configuration in the Amazon MQ Developer Guide.

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/revisions/configuration-revision

HTTP Methods

GET

Returns the specified configuration revision for the specified configuration.

Path

Name Type Description

configuration-id

string

The unique ID that Amazon MQ generates for the configuration.

configuration-revision

string

The revision of the configuration.

Response

Status Code Schema Description

200

DescribeConfigurationRevisionOutput

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.

404

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.

Schemas

Response Schemas

Example DescribeConfigurationRevisionOutput

{
    "configurationId": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
    "revision": 1,
    "description": "Auto-generated default for MyConfiguration on ActiveMQ 5.15.0.",    
    "data": "lciEXAMPLEB4bWxucz0iaHR0cDovL2FjdGl2ZW1xLmFwYWNoZS5vcmcvc2NoZW1hL2NvcmUiCiAgICAgICAgeHNpOnNjaGVtYUxvY2F0aW9uPSJodHRwOi8vYWN0aXZlbXEuYXBhY2hlLm9yZy9zY2hlbWEvY29yZSBodHRwOi8vYWN0aXZlbXEuYXBhY2hlLm9yZy9zY2hlbWEvY29yZS9hY3RpdmVtcS1jb3JlLnhzZCIKICAgICAgICB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIj4KCjwvYnJva2VyPgo",
    "created": "2017-11-27T01:23:45.678Z"
}

Example Error

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

Attributes

DescribeConfigurationRevisionOutput

Attribute Type Description

configurationId

string

Required

The unique ID that Amazon MQ generates for the configuration.

created

string (date-time)

Required

The date and time of the configuration.

data

string (byte)

Required

The base64-encoded XML configuration.

description

string

The description of the configuration.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.