Menu
Amazon MQ
REST API Reference

Configurations

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

HTTP Methods

GET

Returns a list of all configurations.

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

ListConfigurationsOutput

HTTP Status Code 200: OK.

POST

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Note

If the configuration name already exists, Amazon MQ doesn't create a configuration.

Body

Name Type Description

CreateConfigurationInput

CreateConfigurationInput

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Note

If the configuration name already exists, Amazon MQ doesn't create a configuration.

Response

Status Code Schema Description

200

CreateConfigurationOutput

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 input and then retry your request.

409

Error

HTTP Status Code 409: Conflict. This configuration name already exists. Retry your request with another configuration name.

500

Error

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

Schemas

Request Schemas

Example CreateConfigurationInput

{
    "name": "MyConfiguration",
    "engineType": "ActiveMQ",
    "engineVersion": "5.15.0"
}

Response Schemas

Example CreateConfigurationOutput

{
    "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
    "name": "MyConfiguration",
    "arn": "arn:aws:mq:us-east-1:123456789012:configuration:MyConfiguration:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
    "created": "2017-11-27T01:23:45.678Z",
    "latestRevision": {
        "revision": 3,
        "description": "This is the third revision of the configuration. It improves application functionality.",
        "created": "2017-11-27T01:23:45.678Z"        
    }
}

Example ListConfigurationsOutput

{
    "configurations": [{
        "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
        "name": "MyConfigurationDevelopment",
        "arn": "arn:aws:mq:us-east-1:123456789012:configuration:MyConfigurationDevelopment:c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
        "engineType": "ActiveMQ",
        "engineVersion": "5.15.0",
        "description": "My configuration for programming for an ActiveMQ broker.",
        "created": "2017-11-28T01:23:45.678Z",        
        "latestRevision": {
            "revision": 1,
            "description": "Auto-generated default for MyConfiguration on ActiveMQ 5.15.0.",
            "created": "2017-11-27T01:23:45.678Z"            
        }
    }, {     
        "id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9",
        "name": "MyConfigurationTesting",
        "arn": "arn:aws:mq:us-east-1:123456789012:configuration:MyConfigurationTesting:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1",
        "engineType": "ActiveMQ",
        "engineVersion": "5.15.0",
        "description": "My configuration for testing with an ActiveMQ broker.",
        "created": "2017-11-29T01:23:45.678Z",
        "latestRevision": {
            "revision": 3,
            "description": "This is the third revision of a configuration for application testing. It improves application functionality.",
            "created": "2017-11-28T01: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

CreateConfigurationInput

Attribute Type Description

engineType

enum

Required

The type of broker engine.

Note

Currently, Amazon MQ supports only ACTIVEMQ.

engineVersion

enum

Required

The version of the broker engine.

Note

Currently, Amazon MQ supports only 5.15.0.

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.

CreateConfigurationOutput

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.

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.

ListConfigurationsOutput

Attribute Type Description

configurations

array

The list of all revisions for the specified configuration.

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.

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.

Error

Attribute Type Description

errorAttribute

string

The attribute which caused the error.

message

string

The explanation of the error.