StorageGateway / Client / describe_bandwidth_rate_limit_schedule

describe_bandwidth_rate_limit_schedule#

StorageGateway.Client.describe_bandwidth_rate_limit_schedule(**kwargs)#

Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This operation is supported only for volume, tape and S3 file gateways. FSx file gateways do not support bandwidth rate limits.

This operation returns information about a gateway’s bandwidth rate limit schedule. 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.

A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, an ending hour and minute, and bandwidth rate limits for uploading and downloading

If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

See also: AWS API Documentation

Request Syntax

response = client.describe_bandwidth_rate_limit_schedule(
    GatewayARN='string'
)
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.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string',
    'BandwidthRateLimitIntervals': [
        {
            'StartHourOfDay': 123,
            'StartMinuteOfHour': 123,
            'EndHourOfDay': 123,
            'EndMinuteOfHour': 123,
            'DaysOfWeek': [
                123,
            ],
            'AverageUploadRateLimitInBitsPerSec': 123,
            'AverageDownloadRateLimitInBitsPerSec': 123
        },
    ]
}

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.

    • BandwidthRateLimitIntervals (list) –

      An array that contains the bandwidth rate limit intervals for a tape or volume gateway.

      • (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) –

          The hour of the day to start the bandwidth rate limit interval.

        • StartMinuteOfHour (integer) –

          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) –

          The hour of the day to end the bandwidth rate limit interval.

        • EndMinuteOfHour (integer) –

          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) –

          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.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError