update_bandwidth_rate_limit ¶

def update_bandwidth_rate_limit(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
    average_upload_rate_limit_in_bits_per_sec: Optional[
        "capo_storage_gateway.types.bandwidth_upload_rate_limit.BandwidthUploadRateLimit"
    ] = None,
    average_download_rate_limit_in_bits_per_sec: Optional[
        "capo_storage_gateway.types.bandwidth_download_rate_limit.BandwidthDownloadRateLimit"
    ] = None,
) -> "capo_storage_gateway.types.update_bandwidth_rate_limit_output.UpdateBandwidthRateLimitOutput":
    """<p>Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use <a>UpdateBandwidthRateLimitSchedule</a>.</p> <p>By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.</p> <p>To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.</p>

    Args:
        average_upload_rate_limit_in_bits_per_sec: <p>The average upload bandwidth rate limit in bits per second.</p>
        average_download_rate_limit_in_bits_per_sec: <p>The average download bandwidth rate limit in bits per second.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update the bandwidth rate limits of a gateway
        Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.

        >>> client.update_bandwidth_rate_limit(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B', average_upload_rate_limit_in_bits_per_sec=51200, average_download_rate_limit_in_bits_per_sec=102400)
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.update_bandwidth_rate_limit_input.UpdateBandwidthRateLimitInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.update_bandwidth_rate_limit_output.UpdateBandwidthRateLimitOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.update_bandwidth_rate_limit

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.update_bandwidth_rate_limit.update_bandwidth_rate_limit(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateBandwidthRateLimit")
    )
    input_: capo_storage_gateway.types.update_bandwidth_rate_limit_input.UpdateBandwidthRateLimitInput = {
        "gateway_arn": gateway_arn
    }
    if average_upload_rate_limit_in_bits_per_sec is not None:
        input_["average_upload_rate_limit_in_bits_per_sec"] = (
            average_upload_rate_limit_in_bits_per_sec
        )
    if average_download_rate_limit_in_bits_per_sec is not None:
        input_["average_download_rate_limit_in_bits_per_sec"] = (
            average_download_rate_limit_in_bits_per_sec
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output