URI HTTP methods Schemas Properties See also

Configurations

This is a collection of configurations. A configuration contains all of the settings for your broker. 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

Operation ID: ListConfigurations

Returns a list of all configurations.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
`maxResults`	String	False	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 code	Response model	Description
`200`	`ListConfigurationsOutput`	HTTP Status Code 200: OK.
`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.
`500`	`Error`	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

POST

Operation ID: CreateConfiguration

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

Responses
Status code	Response model	Description
`200`	`CreateConfigurationOutput`	HTTP Status Code 200: OK.
`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.
`409`	`Error`	HTTP Status Code 409: Configuration ID is already in use. Remove the configuration from all brokers and retry the request.
`500`	`Error`	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

OPTIONS

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Request bodies


{
  "engineVersion engineVersion": "string",
  "authenticationStrategy authenticationStrategy": enum,
  "name name": "string",
  "engineType engineType": enum,
  "tags tags": {
  }
}

Response bodies


{
  "nextToken nextToken": "string",
  "maxResults maxResults": integer,
  "configurations configurations": [
    {
      "engineVersion engineVersion": "string",
      "created created": "string",
      "authenticationStrategy authenticationStrategy": enum,
      "name name": "string",
      "description description": "string",
      "engineType engineType": enum,
      "id id": "string",
      "arn arn": "string",
      "latestRevision latestRevision": {
        "created created": "string",
        "description description": "string",
        "revision revision": integer
      },
      "tags tags": {
      }
    }
  ]
}


{
  "created created": "string",
  "authenticationStrategy authenticationStrategy": enum,
  "name name": "string",
  "id id": "string",
  "arn arn": "string",
  "latestRevision latestRevision": {
    "created created": "string",
    "description description": "string",
    "revision revision": integer
  }
}


{
  "errorAttribute errorAttribute": "string",
  "message message": "string"
}

Properties

AuthenticationStrategy

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

SIMPLE
LDAP
CONFIG_MANAGED

Configuration

Returns information about all configurations.

Property	Type	Required	Description
`arn`	string	True	Required. The ARN of the configuration.
`authenticationStrategy`	AuthenticationStrategy	True	Optional. The authentication strategy associated with the configuration. The default is `SIMPLE`.
`created`	string Format: date-time	True	Required. The date and time of the configuration revision.
`description`	string	True	Required. The description of the configuration.
`engineType`	EngineType	True	Required. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ`.
`engineVersion`	string	True	The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
`id`	string	True	Required. The unique ID that Amazon MQ generates for the configuration.
`latestRevision`	ConfigurationRevision	True	Required. The latest revision of the configuration.
`name`	string	True	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.
`tags`	object	False	The list of all tags associated with this configuration.

engineVersion

The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Type: string
Required: True

created

Required. The date and time of the configuration revision.

Type: string
Required: True
Format: date-time

authenticationStrategy

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

Type: AuthenticationStrategy
Required: True

name

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.

Type: string
Required: True

description

Required. The description of the configuration.

Type: string
Required: True

engineType

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Type: EngineType
Required: True

id

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

Type: string
Required: True

arn

Required. The ARN of the configuration.

Type: string
Required: True

latestRevision

Required. The latest revision of the configuration.

Type: ConfigurationRevision
Required: True

ConfigurationRevision

Returns information about the specified configuration revision.

Property Type Required Description

Property	Type	Required	Description
`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.

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.

created

Required. The date and time of the configuration revision.

Type: string
Required: True
Format: date-time

description

The description of the configuration revision.

Type: string
Required: False

revision

Required. The revision number of the configuration.

Type: integer
Required: True

CreateConfigurationInput

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

Property	Type	Required	Description
`authenticationStrategy`	AuthenticationStrategy	False	Optional. The authentication strategy associated with the configuration. The default is `SIMPLE`.
`engineType`	EngineType	True	Required. The type of broker engine. Currently, Amazon MQ supports `ACTIVEMQ` and `RABBITMQ`.
`engineVersion`	string	False	The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
`name`	string	True	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.
`tags`	object	False	Create tags when creating the configuration.

engineVersion

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Type: string
Required: False

authenticationStrategy

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

Type: AuthenticationStrategy
Required: False

name

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.

Type: string
Required: True

engineType

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Type: EngineType
Required: True

CreateConfigurationOutput

Returns information about the created configuration.

Property	Type	Required	Description
`arn`	string	True	Required. The Amazon Resource Name (ARN) of the configuration.
`authenticationStrategy`	AuthenticationStrategy	True	Optional. The authentication strategy associated with the configuration. The default is `SIMPLE`.
`created`	string Format: date-time	True	Required. The date and time of the configuration.
`id`	string	True	Required. The unique ID that Amazon MQ generates for the configuration.
`latestRevision`	ConfigurationRevision	False	The latest revision of the configuration.
`name`	string	True	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.

created

Required. The date and time of the configuration.

Type: string
Required: True
Format: date-time

authenticationStrategy

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

Type: AuthenticationStrategy
Required: True

name

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.

Type: string
Required: True

id

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

Type: string
Required: True

arn

Required. The Amazon Resource Name (ARN) of the configuration.

Type: string
Required: True

latestRevision

The latest revision of the configuration.

Type: ConfigurationRevision
Required: False

EngineType

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

ACTIVEMQ
RABBITMQ

Error

Returns information about an error.

Property	Type	Required	Description
`errorAttribute`	string	False	The attribute which caused the error.
`message`	string	False	The explanation of the error.

errorAttribute

The attribute which caused the error.

Type: string
Required: False

message

The explanation of the error.

Type: string
Required: False

ListConfigurationsOutput

Returns a list of all configurations.

Property	Type	Required	Description
`configurations`	Array of type Configuration	False	The list of all revisions for the specified configuration.
`maxResults`	integer	False	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	False	The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

nextToken

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

Type: string
Required: False

maxResults

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.

Type: integer
Required: False

configurations

The list of all revisions for the specified configuration.

Type: Array of type Configuration
Required: False