bandwidth_rate_limits
Creates, updates, deletes, gets or lists a bandwidth_rate_limits resource.
Overview
| Name | bandwidth_rate_limits |
| Type | Resource |
| Id | aws.storagegateway.bandwidth_rate_limits |
Fields
The following fields are returned by SELECT queries:
- describe_bandwidth_rate_limit
| Name | Datatype | Description |
|---|---|---|
average_download_rate_limit_in_bits_per_sec | integer (int64) | The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set. |
average_upload_rate_limit_in_bits_per_sec | integer (int64) | The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set. |
gateway_arn | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_bandwidth_rate_limit | select | region | Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule. This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. | |
update_bandwidth_rate_limit | update | region, GatewayARN | Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. | |
delete_bandwidth_rate_limit | delete | region | Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_bandwidth_rate_limit
Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect. This operation is supported only for the stored volume, cached volume, and tape gateway types. To describe bandwidth rate limits for S3 file gateways, use DescribeBandwidthRateLimitSchedule. This operation returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
SELECT
average_download_rate_limit_in_bits_per_sec,
average_upload_rate_limit_in_bits_per_sec,
gateway_arn
FROM aws.storagegateway.bandwidth_rate_limits
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_bandwidth_rate_limit
Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains. This operation is supported only for the stored volume, cached volume, and tape gateway types. To update bandwidth rate limits for S3 file gateways, use UpdateBandwidthRateLimitSchedule. By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
UPDATE aws.storagegateway.bandwidth_rate_limits
SET
GatewayARN = '{{ GatewayARN }}',
AverageUploadRateLimitInBitsPerSec = {{ AverageUploadRateLimitInBitsPerSec }},
AverageDownloadRateLimitInBitsPerSec = {{ AverageDownloadRateLimitInBitsPerSec }}
WHERE
region = '{{ region }}' --required
AND GatewayARN = '{{ GatewayARN }}' --required
RETURNING
gateway_arn;
DELETE examples
- delete_bandwidth_rate_limit
Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.
DELETE FROM aws.storagegateway.bandwidth_rate_limits
WHERE region = '{{ region }}' --required
;