Kafka / Client / update_broker_storage

update_broker_storage¶

Kafka.Client.update_broker_storage(**kwargs)¶

Updates the EBS storage associated with MSK brokers.

Request Syntax

response = client.update_broker_storage(
    ClusterArn='string',
    CurrentVersion='string',
    TargetBrokerEBSVolumeInfo=[
        {
            'KafkaBrokerNodeId': 'string',
            'ProvisionedThroughput': {
                'Enabled': True|False,
                'VolumeThroughput': 123
            },
            'VolumeSizeGB': 123
        },
    ]
)

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.
CurrentVersion (string) –
[REQUIRED]

The version of cluster to update from. A successful operation will then generate a new version.
TargetBrokerEBSVolumeInfo (list) –
[REQUIRED]

Describes the target volume size and the ID of the broker to apply the update to.
- (dict) –
  
  Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.
  - KafkaBrokerNodeId (string) – [REQUIRED]
    
    The ID of the broker to update.
  - 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.
  - VolumeSizeGB (integer) –
    
    Size of the EBS volume to update.

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.ServiceUnavailableException
Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException