Skip to content

BandwidthRateLimitInterval

Source code in docs_src/capo_storage_gateway/types/bandwidth_rate_limit_interval.py
class BandwidthRateLimitInterval(TypedDict, closed=True):
    start_hour_of_day: "capo_storage_gateway.types.hour_of_day.HourOfDay"
    """<p> The hour of the day to start the bandwidth rate limit interval. </p>"""
    start_minute_of_hour: "capo_storage_gateway.types.minute_of_hour.MinuteOfHour"
    """<p> 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 <code>0</code>. </p>"""
    end_hour_of_day: "capo_storage_gateway.types.hour_of_day.HourOfDay"
    """<p> The hour of the day to end the bandwidth rate limit interval. </p>"""
    end_minute_of_hour: "capo_storage_gateway.types.minute_of_hour.MinuteOfHour"
    """<p> The minute of the hour to end the bandwidth rate limit interval. </p> <important> <p> 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 <code>59</code>. </p> </important>"""
    days_of_week: "capo_storage_gateway.types.days_of_week.DaysOfWeek"
    """<p> 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. </p>"""
    average_upload_rate_limit_in_bits_per_sec: NotRequired[
        "capo_storage_gateway.types.bandwidth_upload_rate_limit.BandwidthUploadRateLimit"
    ]
    """<p> 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. </p> <note> <p>For Tape Gateway and Volume Gateway, the minimum value is <code>51200</code>.</p> <p>This field is required for S3 File Gateway, and the minimum value is <code>104857600</code>.</p> </note>"""
    average_download_rate_limit_in_bits_per_sec: NotRequired[
        "capo_storage_gateway.types.bandwidth_download_rate_limit.BandwidthDownloadRateLimit"
    ]
    """<p> 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. </p> <note> <p>S3 File Gateway does not support this feature.</p> </note>"""

average_download_rate_limit_in_bits_per_sec instance-attribute

average_download_rate_limit_in_bits_per_sec: NotRequired[BandwidthDownloadRateLimit]

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.

S3 File Gateway does not support this feature.

average_upload_rate_limit_in_bits_per_sec instance-attribute

average_upload_rate_limit_in_bits_per_sec: NotRequired[BandwidthUploadRateLimit]

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.

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.

days_of_week instance-attribute

days_of_week: DaysOfWeek

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.

end_hour_of_day instance-attribute

end_hour_of_day: HourOfDay

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

end_minute_of_hour instance-attribute

end_minute_of_hour: MinuteOfHour

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

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.

start_hour_of_day instance-attribute

start_hour_of_day: HourOfDay

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

start_minute_of_hour instance-attribute

start_minute_of_hour: MinuteOfHour

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.