update_storage

Kafka.Client.update_storage(**kwargs)

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

See also: AWS API Documentation

Request Syntax

response = client.update_storage(
    ClusterArn='string',
    CurrentVersion='string',
    ProvisionedThroughput={
        'Enabled': True|False,
        'VolumeThroughput': 123
    },
    StorageMode='LOCAL'|'TIERED',
    VolumeSizeGB=123
)

Parameters

• ClusterArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the cluster to be updated.

• CurrentVersion (string) --

  [REQUIRED]

  The version of cluster to update from. A successful operation will then generate a new version.

• ProvisionedThroughput (dict) --

  EBS volume provisioned throughput information.

  • Enabled (boolean) --

    Provisioned throughput is enabled or not.

  • VolumeThroughput (integer) --

    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

• StorageMode (string) -- Controls storage mode for supported storage tiers.
• VolumeSizeGB (integer) -- size of the EBS volume to update.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) -- HTTP Status Code 200: OK.

  • 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
• Kafka.Client.exceptions.TooManyRequestsException