Skip to content

This action sets the bandwidth rate limit schedule for a specified gateway

Description

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.

Usage

backupgateway_put_bandwidth_rate_limit_schedule(GatewayArn,
  BandwidthRateLimitIntervals)

Arguments

  • GatewayArn

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

  • BandwidthRateLimitIntervals

    [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.

Value

A list with the following syntax:

list(
  GatewayArn = "string"
)

Request syntax

svc$put_bandwidth_rate_limit_schedule(
  GatewayArn = "string",
  BandwidthRateLimitIntervals = list(
    list(
      AverageUploadRateLimitInBitsPerSec = 123,
      StartHourOfDay = 123,
      EndHourOfDay = 123,
      StartMinuteOfHour = 123,
      EndMinuteOfHour = 123,
      DaysOfWeek = list(
        123
      )
    )
  )
)