Container for the parameters to the DescribeBandwidthRateLimit operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.StorageGateway.AmazonStorageGatewayRequest
Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest
Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z
Syntax
public class DescribeBandwidthRateLimitRequest : AmazonStorageGatewayRequest IAmazonWebServiceRequest
The DescribeBandwidthRateLimitRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeBandwidthRateLimitRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
GatewayARN | System.String |
Gets and sets the property GatewayARN. |
Examples
Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.
To describe the bandwidth rate limits of a gateway
var client = new AmazonStorageGatewayClient();
var response = client.DescribeBandwidthRateLimit(new DescribeBandwidthRateLimitRequest
{
GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
});
long averageDownloadRateLimitInBitsPerSec = response.AverageDownloadRateLimitInBitsPerSec;
long averageUploadRateLimitInBitsPerSec = response.AverageUploadRateLimitInBitsPerSec;
string gatewayARN = response.GatewayARN;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5