Kafka / Client / describe_configuration

describe_configuration#

Kafka.Client.describe_configuration(**kwargs)#

Returns a description of this MSK configuration.

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration(
    Arn='string'
)
Parameters:

Arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'Description': 'string',
    'KafkaVersions': [
        'string',
    ],
    'LatestRevision': {
        'CreationTime': datetime(2015, 1, 1),
        'Description': 'string',
        'Revision': 123
    },
    'Name': 'string',
    'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}

Response Structure

  • (dict) –

    200 response

    • Arn (string) –

      The Amazon Resource Name (ARN) of the configuration.

    • CreationTime (datetime) –

      The time when the configuration was created.

    • Description (string) –

      The description of the configuration.

    • KafkaVersions (list) –

      The versions of Apache Kafka with which you can use this MSK configuration.

      • (string) –

    • LatestRevision (dict) –

      Latest revision of the configuration.

      • CreationTime (datetime) –

        The time when the configuration revision was created.

      • Description (string) –

        The description of the configuration revision.

      • Revision (integer) –

        The revision number.

    • Name (string) –

      The name of the configuration.

    • State (string) –

      The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

Exceptions

  • Kafka.Client.exceptions.BadRequestException

  • Kafka.Client.exceptions.UnauthorizedException

  • Kafka.Client.exceptions.InternalServerErrorException

  • Kafka.Client.exceptions.ForbiddenException

  • Kafka.Client.exceptions.NotFoundException

  • Kafka.Client.exceptions.ServiceUnavailableException