describe_configuration

MQ.Client.describe_configuration(**kwargs)

Returns information about the specified configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration(
    ConfigurationId='string'
)
Parameters
ConfigurationId (string) --

[REQUIRED]

The unique ID that Amazon MQ generates for the configuration.

Return type
dict
Returns
Response Syntax
{
    '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'
    }
}

Response Structure

  • (dict) --

    HTTP Status Code 200: OK.

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

Exceptions

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