Kafka / Client / update_cluster_configuration

update_cluster_configuration#

Kafka.Client.update_cluster_configuration(**kwargs)#

Updates the cluster with the configuration that is specified in the request body.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster_configuration(
    ClusterArn='string',
    ConfigurationInfo={
        'Arn': 'string',
        'Revision': 123
    },
    CurrentVersion='string'
)
Parameters:
  • ClusterArn (string) –

    [REQUIRED]

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

  • ConfigurationInfo (dict) –

    [REQUIRED]

    Represents the configuration that you want MSK to use for the brokers in a cluster.

    • Arn (string) – [REQUIRED]

      ARN of the configuration to use.

    • Revision (integer) – [REQUIRED]

      The revision of the configuration to use.

  • CurrentVersion (string) –

    [REQUIRED]

    The version of the cluster that needs to be updated.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

  • (dict) –

    Successful response.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • ClusterOperationArn (string) –

      The Amazon Resource Name (ARN) of the cluster operation.

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