BackupGateway / Client / get_bandwidth_rate_limit_schedule

get_bandwidth_rate_limit_schedule#

BackupGateway.Client.get_bandwidth_rate_limit_schedule(**kwargs)#

Retrieves 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 get a gateway’s bandwidth rate limit schedule.

See also: AWS API Documentation

Request Syntax

response = client.get_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

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

Response Structure

  • (dict) –

    • BandwidthRateLimitIntervals (list) –

      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.

        • 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 Backup Gateway, the minimum value is (Value).

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

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

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

    • 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

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.ResourceNotFoundException

  • BackupGateway.Client.exceptions.ThrottlingException