update_bandwidth_rate_limit_schedule ¶

def update_bandwidth_rate_limit_schedule(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    bandwidth_rate_limit_intervals: "capo_storage_gateway.types.bandwidth_rate_limit_intervals.BandwidthRateLimitIntervals",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.update_bandwidth_rate_limit_schedule_output.UpdateBandwidthRateLimitScheduleOutput":
    """<p> Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This operation is supported for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.</p>

    Args:
        bandwidth_rate_limit_intervals: <p> An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty. </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.
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.update_bandwidth_rate_limit_schedule_input.UpdateBandwidthRateLimitScheduleInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.update_bandwidth_rate_limit_schedule_output.UpdateBandwidthRateLimitScheduleOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.update_bandwidth_rate_limit_schedule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateBandwidthRateLimitSchedule")
    )
    input_: capo_storage_gateway.types.update_bandwidth_rate_limit_schedule_input.UpdateBandwidthRateLimitScheduleInput = {
        "gateway_arn": gateway_arn,
        "bandwidth_rate_limit_intervals": bandwidth_rate_limit_intervals,
    }

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