Managed Streaming for Kafka

2020/08/24 - Managed Streaming for Kafka - 2 new3 updated api methods

Changes  Update kafka client to latest version

DeleteConfiguration (new) Link ¶

Deletes an MSK Configuration.

See also: AWS API Documentation

Request Syntax

client.delete_configuration(
    Arn='string'
)
type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'State': 'ACTIVE'|'DELETING'|'DELETE_FAILED'
}

Response Structure

  • (dict) --

    Successful response.

    • Arn (string) --

      The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.

    • State (string) --

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

UpdateConfiguration (new) Link ¶

Updates an MSK configuration.

See also: AWS API Documentation

Request Syntax

client.update_configuration(
    Arn='string',
    Description='string',
    ServerProperties=b'bytes'
)
type Arn:

string

param Arn:

[REQUIRED]

The Amazon Resource Name (ARN) of the configuration.

type Description:

string

param Description:

The description of the configuration revision.

type ServerProperties:

bytes

param ServerProperties:

[REQUIRED]

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'LatestRevision': {
        'CreationTime': datetime(2015, 1, 1),
        'Description': 'string',
        'Revision': 123
    }
}

Response Structure

  • (dict) --

    200 response

    • Arn (string) --

      The Amazon Resource Name (ARN) of the configuration.

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

CreateConfiguration (updated) Link ¶
Changes (response) 
{'State': 'ACTIVE | DELETING | DELETE_FAILED'}

Creates a new MSK configuration.

See also: AWS API Documentation

Request Syntax

client.create_configuration(
    Description='string',
    KafkaVersions=[
        'string',
    ],
    Name='string',
    ServerProperties=b'bytes'
)
type Description:

string

param Description:

The description of the configuration.

type KafkaVersions:

list

param KafkaVersions:

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

  • (string) --

type Name:

string

param Name:

[REQUIRED]

The name of the configuration.

type ServerProperties:

bytes

param ServerProperties:

[REQUIRED]

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    '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.

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

DescribeConfiguration (updated) Link ¶
Changes (response) 
{'State': 'ACTIVE | DELETING | DELETE_FAILED'}

Returns a description of this MSK configuration.

See also: AWS API Documentation

Request Syntax

client.describe_configuration(
    Arn='string'
)
type Arn:

string

param Arn:

[REQUIRED]

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

rtype:

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.

ListConfigurations (updated) Link ¶
Changes (response) 
{'Configurations': {'State': 'ACTIVE | DELETING | DELETE_FAILED'}}

Returns a list of all the MSK configurations in this Region.

See also: AWS API Documentation

Request Syntax

client.list_configurations(
    MaxResults=123,
    NextToken='string'
)
type MaxResults:

integer

param MaxResults:

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

type NextToken:

string

param NextToken:

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

rtype:

dict

returns:

Response Syntax

{
    'Configurations': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    200 response

    • Configurations (list) --

      An array of MSK configurations.

      • (dict) --

        Represents an MSK Configuration.

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

          An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

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

    • NextToken (string) --

      The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.