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.

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.

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.

Note:

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

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

Syntax

C#
public abstract UpdateBandwidthRateLimitResponse UpdateBandwidthRateLimit(
         UpdateBandwidthRateLimitRequest request
)
Parameters
request
Type: Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest

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

Return Value
The response from the UpdateBandwidthRateLimit 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

Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.

To update the bandwidth rate limits of a gateway


var response = client.UpdateBandwidthRateLimit(new UpdateBandwidthRateLimitRequest 
{
    AverageDownloadRateLimitInBitsPerSec = 102400,
    AverageUploadRateLimitInBitsPerSec = 51200,
    GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
});

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