AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) 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 only 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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DescribeBandwidthRateLimitAsync.

Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public abstract DescribeBandwidthRateLimitResponse DescribeBandwidthRateLimit(
         DescribeBandwidthRateLimitRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.DescribeBandwidthRateLimitRequest

Container for the necessary parameters to execute the DescribeBandwidthRateLimit service method.

Return Value
The response from the DescribeBandwidthRateLimit service method, as returned by StorageGateway.

Exceptions

ExceptionCondition
InternalServerErrorException An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

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 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 Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also