Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_configurations

list_configurations(**kwargs)

Returns a list of all configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_configurations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- 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.
  • NextToken (string) -- The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
Return type

dict

Returns

Response Syntax

{
    'Configurations': [
        {
            'Arn': 'string',
            'AuthenticationStrategy': 'SIMPLE'|'LDAP',
            'Created': datetime(2015, 1, 1),
            'Description': 'string',
            'EngineType': 'ACTIVEMQ'|'RABBITMQ',
            'EngineVersion': 'string',
            'Id': 'string',
            'LatestRevision': {
                'Created': datetime(2015, 1, 1),
                'Description': 'string',
                'Revision': 123
            },
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'MaxResults': 123,
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    HTTP Status Code 200: OK.

    • Configurations (list) --

      The list of all revisions for the specified configuration.

      • (dict) --

        Returns information about all configurations.

        • Arn (string) --

          Required. The ARN of the configuration.

        • AuthenticationStrategy (string) --

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

        • Created (datetime) --

          Required. The date and time of the configuration revision.

        • Description (string) --

          Required. The description of the configuration.

        • EngineType (string) --

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

        • EngineVersion (string) --

          Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.

        • Id (string) --

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

        • LatestRevision (dict) --

          Required. The latest revision of the configuration.

          • Created (datetime) --

            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.

        • 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.

        • Tags (dict) --

          The list of all tags associated with this configuration.

          • (string) --
            • (string) --
    • 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.

Exceptions

  • MQ.Client.exceptions.BadRequestException
  • MQ.Client.exceptions.InternalServerErrorException
  • MQ.Client.exceptions.ForbiddenException