StorageGateway / Client / update_bandwidth_rate_limit_schedule

update_bandwidth_rate_limit_schedule#

StorageGateway.Client.update_bandwidth_rate_limit_schedule(**kwargs)#

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.

Request Syntax

response = client.update_bandwidth_rate_limit_schedule(
    GatewayARN='string',
    BandwidthRateLimitIntervals=[
        {
            'StartHourOfDay': 123,
            'StartMinuteOfHour': 123,
            'EndHourOfDay': 123,
            'EndMinuteOfHour': 123,
            'DaysOfWeek': [
                123,
            ],
            'AverageUploadRateLimitInBitsPerSec': 123,
            'AverageDownloadRateLimitInBitsPerSec': 123
        },
    ]
)

Parameters:

GatewayARN (string) –
[REQUIRED]

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.
BandwidthRateLimitIntervals (list) –
[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.
- (dict) –
  
  Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
  
  Note
  FSx File Gateway does not support this feature.
  - StartHourOfDay (integer) – [REQUIRED]
    
    The hour of the day to start 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 0.
  - EndHourOfDay (integer) – [REQUIRED]
    
    The hour of the day to end the bandwidth rate limit interval.
  - EndMinuteOfHour (integer) – [REQUIRED]
    
    The minute of the hour to end the bandwidth rate limit interval.
    
    Warning
    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 59.
  - DaysOfWeek (list) – [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.
    - (integer) –
  - 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.
    
    Note
    For Tape Gateway and Volume Gateway, the minimum value is 51200.
    
    This field is required for S3 File Gateway, and the minimum value is 104857600.
  - AverageDownloadRateLimitInBitsPerSec (integer) –
    
    The average download rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the download rate limit is not set.
    
    Note
    S3 File Gateway does not support this feature.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

(dict) –
- GatewayARN (string) –
  
  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.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError