Configuration Revision - Amazon MQ

Configuration Revision

Note

Does not apply to RabbitMQ brokers.

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

Operation ID: DescribeConfigurationRevision

Returns the specified configuration revision for the specified configuration.

Path parameters
NameTypeRequiredDescription
configuration-revisionStringTrue

The revision of the configuration.

configuration-idStringTrue

The unique ID that Amazon MQ generates for the configuration.

Responses
Status codeResponse modelDescription
200 DescribeConfigurationRevisionOutput

HTTP Status Code 200: OK.

400Error

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

403Error

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

404Error

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

500Error

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

OPTIONS

Path parameters
NameTypeRequiredDescription
configuration-revisionStringTrue

The revision of the configuration.

configuration-idStringTrue

The unique ID that Amazon MQ generates for the configuration.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{ "data": "string", "created": "string", "description": "string", "configurationId": "string" }
{ "errorAttribute": "string", "message": "string" }

Properties

DescribeConfigurationRevisionOutput

Returns the specified configuration revision for the specified configuration.

PropertyTypeRequiredDescription
configurationId

string

True

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

created

string

Format: date-time

True

Required. The date and time of the configuration.

data

string

Format: byte

True

Required. The base64-encoded XML configuration.

description

string

False

The description of the configuration.

Error

Returns information about an error.

PropertyTypeRequiredDescription
errorAttribute

string

False

The attribute which caused the error.

message

string

False

The explanation of the error.

See also

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

DescribeConfigurationRevision