Skip to content

update_broker_storage async

update_broker_storage(
    cluster_arn: __string,
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    current_version: Optional[__string] = None,
    target_broker_ebs_volume_info: Optional[__listOfBrokerEBSVolumeInfo] = None,
) -> UpdateBrokerStorageResponse

Updates the EBS storage associated with MSK brokers.

Parameters:

  • cluster_arn (__string) –

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

  • current_version (Optional[__string], default: None ) –

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

  • target_broker_ebs_volume_info (Optional[__listOfBrokerEBSVolumeInfo], default: None ) –

    Describes the target volume size and the ID of the broker to apply the update to.

Raises:

Source code in docs_src/capo_kafka/_services/async_kafka.py
async def update_broker_storage(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    current_version: Optional["capo_kafka.types.__string.__string"] = None,
    target_broker_ebs_volume_info: Optional[
        "capo_kafka.types.__list_of_broker_ebs_volume_info.__listOfBrokerEBSVolumeInfo"
    ] = None,
) -> "capo_kafka.types.update_broker_storage_response.UpdateBrokerStorageResponse":
    """<p>Updates the EBS storage associated with MSK brokers.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
        current_version: <p>The version of cluster to update from. A successful operation will then generate a new version.</p>
        target_broker_ebs_volume_info: <p>Describes the target volume size and the ID of the broker to apply the update to.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.service_unavailable_exception.ServiceUnavailableException: <p>Returns information about an error.</p>
        capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kafka.types.update_broker_storage_request.UpdateBrokerStorageRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.update_broker_storage_response.UpdateBrokerStorageResponse"
    ]:
        import capo_kafka._operations.kafka.update_broker_storage

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.update_broker_storage.async_update_broker_storage(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateBrokerStorage")
    )
    input_: capo_kafka.types.update_broker_storage_request.UpdateBrokerStorageRequest = {
        "cluster_arn": cluster_arn
    }
    if current_version is not None:
        input_["current_version"] = current_version
    if target_broker_ebs_volume_info is not None:
        input_["target_broker_ebs_volume_info"] = target_broker_ebs_volume_info

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output