Kafka / Client / delete_cluster

delete_cluster#

Kafka.Client.delete_cluster(**kwargs)#

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

See also: AWS API Documentation

Request Syntax

response = client.delete_cluster(
    ClusterArn='string',
    CurrentVersion='string'
)
Parameters:

  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that uniquely identifies the cluster.

  • CurrentVersion (string) – The current version of the MSK cluster.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'State': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'HEALING'|'MAINTENANCE'|'REBOOTING_BROKER'|'UPDATING'
}

Response Structure

  • (dict) –

    Successful response.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • State (string) –

      The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

Exceptions

  • Kafka.Client.exceptions.NotFoundException

  • Kafka.Client.exceptions.BadRequestException

  • Kafka.Client.exceptions.InternalServerErrorException

  • Kafka.Client.exceptions.ForbiddenException