---
title: "POST /#X-Amz-Target=BackupOnPremises_v20210101.PutBandwidthRateLimitSchedule"
method: POST
path: "/#X-Amz-Target=BackupOnPremises_v20210101.PutBandwidthRateLimitSchedule"
---

# POST /#X-Amz-Target=BackupOnPremises_v20210101.PutBandwidthRateLimitSchedule

`POST /#X-Amz-Target=BackupOnPremises_v20210101.PutBandwidthRateLimitSchedule`

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

## Headers

- `X-Amz-Target` 'BackupOnPremises_v20210101.PutBandwidthRateLimitSchedule', required

## Request body

- PutBandwidthRateLimitScheduleInput
  - `GatewayArn` string, required — The Amazon Resource Name (ARN) of the gateway. Use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html"> <code>ListGateways</code> </a> operation to return a list of gateways for your account and Amazon Web Services Region.
  - `BandwidthRateLimitIntervals` BandwidthRateLimitInterval[], required — An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
    - `AverageUploadRateLimitInBitsPerSec` integer — The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.
    - `StartHourOfDay` integer, required — The hour of the day to start the bandwidth rate limit interval.
    - `EndHourOfDay` integer, required — The hour of the day to end the bandwidth rate limit interval.
    - `StartMinuteOfHour` integer, required — The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value <code>0</code>.
    - `EndMinuteOfHour` integer, required — <p>The minute of the hour to end the bandwidth rate limit interval.</p> <important> <p>The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value <code>59</code>.</p> </important>
    - `DaysOfWeek` DayOfWeek[], required — The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

## Response `200`

Success

- PutBandwidthRateLimitScheduleOutput
  - `GatewayArn` string — The Amazon Resource Name (ARN) of the gateway. Use the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html"> <code>ListGateways</code> </a> operation to return a list of gateways for your account and Amazon Web Services Region.

## Other responses

- `480` — ValidationException
- `481` — InternalServerException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/backup-gateway.md) · [All operations](https://skmtc.net/aws/apis/backup-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/backup-gateway/versions/5f9c8ce5c0f7/schema)