Amazon MQ
REST API Reference

Configuration Revisions

This is a collection of configuration revisions. 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

HTTP Methods

GET

Returns a list of all revisions for the specified configuration.

Path

Name Type Description

configuration-id

string

The unique ID that Amazon MQ generates for the configuration.

Query

Name Type Description

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.

Response

Status Code Schema Description

200

ListConfigurationRevisionsOutput

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.

500

Error

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

Schemas

Response Schemas

Example ListConfigurationRevisionsOutput

{ "configurationId": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "revisions": [{ "revision": 1, "description": "Auto-generated default for MyConfiguration on ActiveMQ 5.15.6.", "created": "2017-11-28T01:23:45.678Z" }, { "revision": 2, "description": "This is the second revision of a configuration for application development. It improves application functionality.", "created": "2017-11-29T01:23:45.678Z" }], "maxResults": 20, "nextToken": "eyEXAMPLEW9uIjoidjEiLCJzZXJpYWxpemVkUGFnaW5hdGlvblRva2VuIjoiZXlKMGIydGxia1JoZEdFaU9uc2liR0Z6ZEMxelpXVnVMV0p5YjJ0bGNpMWhjbTRpT2lJeEluMTkifQ==" }

Example Error

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

Attributes

ListConfigurationRevisionsOutput

Attribute Type Description

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

The list of all revisions for the specified configuration.

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.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.