Configuration Revisions - Amazon MQ
URIHTTP methodsSchemasProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

Operation ID: ListConfigurationRevisions

Returns a list of all revisions for the specified configuration.

Path parameters
NameTypeRequiredDescription
configuration-idStringTrue

The unique ID that Amazon MQ generates for the configuration.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

maxResultsStringFalse

The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.

Responses
Status codeResponse modelDescription
200 ListConfigurationRevisionsOutput

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.

Schemas

Response bodies

{
  "nextToken": "string",
  "maxResults": integer,
  "revisions": [
    {
      "created": "string",
      "description": "string",
      "revision": integer
    }
  ],
  "configurationId": "string"
}
{
  "errorAttribute": "string",
  "message": "string"
}

Properties

ConfigurationRevision

Returns information about the specified configuration revision.

PropertyTypeRequiredDescription
created

string

Format: date-time

True

Required. The date and time of the configuration revision.

description

string

False

The description of the configuration revision.

revision

integer

True

Required. The revision number 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.

ListConfigurationRevisionsOutput

Returns a list of all revisions for the specified configuration.

PropertyTypeRequiredDescription
configurationId

string

False

The unique ID that Amazon MQ generates for the configuration.

maxResults

integer

False

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

False

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

revisions

Array of type ConfigurationRevision

False

The list of all revisions for the specified configuration.