PutBandwidthRateLimitScheduleCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupGatewayClient, PutBandwidthRateLimitScheduleCommand } from "@aws-sdk/client-backup-gateway"; // ES Modules import
// const { BackupGatewayClient, PutBandwidthRateLimitScheduleCommand } = require("@aws-sdk/client-backup-gateway"); // CommonJS import
const client = new BackupGatewayClient(config);
const input = { // PutBandwidthRateLimitScheduleInput
  GatewayArn: "STRING_VALUE", // required
  BandwidthRateLimitIntervals: [ // BandwidthRateLimitIntervals // required
    { // BandwidthRateLimitInterval
      AverageUploadRateLimitInBitsPerSec: Number("long"),
      StartHourOfDay: Number("int"), // required
      EndHourOfDay: Number("int"), // required
      StartMinuteOfHour: Number("int"), // required
      EndMinuteOfHour: Number("int"), // required
      DaysOfWeek: [ // DaysOfWeek // required
        Number("int"),
      ],
    },
  ],
};
const command = new PutBandwidthRateLimitScheduleCommand(input);
const response = await client.send(command);
// { // PutBandwidthRateLimitScheduleOutput
//   GatewayArn: "STRING_VALUE",
// };

PutBandwidthRateLimitScheduleCommand Input

Parameter
Type
Description
BandwidthRateLimitIntervals
Required
BandwidthRateLimitInterval[] | undefined

An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

GatewayArn
Required
string | undefined

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways   operation to return a list of gateways for your account and Amazon Web Services Region.

PutBandwidthRateLimitScheduleCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GatewayArn
string | undefined

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways   operation to return a list of gateways for your account and Amazon Web Services Region.

Throws

Name
Fault
Details
ResourceNotFoundException
client

A resource that is required for the action wasn't found.

InternalServerException
server

The operation did not succeed because an internal error occurred. Try again later.

ThrottlingException
client

TPS has been limited to protect against intentional or unintentional high request volumes.

ValidationException
client

The operation did not succeed because a validation error occurred.

BackupGatewayServiceException
Base exception class for all service exceptions from BackupGateway service.