Update Bandwidth Rate Limit Schedule

storagegateway_update_bandwidth_rate_limit_schedule

R Documentation

Updates the bandwidth rate limit schedule for a specified gateway¶

Description¶

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.

Usage¶

storagegateway_update_bandwidth_rate_limit_schedule(GatewayARN,
  BandwidthRateLimitIntervals)

Arguments¶

GatewayARN: [required]
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$update_bandwidth_rate_limit_schedule(
  GatewayARN = "string",
  BandwidthRateLimitIntervals = list(
    list(
      StartHourOfDay = 123,
      StartMinuteOfHour = 123,
      EndHourOfDay = 123,
      EndMinuteOfHour = 123,
      DaysOfWeek = list(
        123
      ),
      AverageUploadRateLimitInBitsPerSec = 123,
      AverageDownloadRateLimitInBitsPerSec = 123
    )
  )
)