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.

Container for the parameters to the UpdateBandwidthRateLimit operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.UpdateBandwidthRateLimitRequest

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

Syntax

C#
public class UpdateBandwidthRateLimitRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The UpdateBandwidthRateLimitRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AverageDownloadRateLimitInBitsPerSec System.Int64

Gets and sets the property AverageDownloadRateLimitInBitsPerSec.

The average download bandwidth rate limit in bits per second.

Public Property AverageUploadRateLimitInBitsPerSec System.Int64

Gets and sets the property AverageUploadRateLimitInBitsPerSec.

The average upload bandwidth rate limit in bits per second.

Public Property GatewayARN System.String

Gets and sets the property GatewayARN.

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 Standard:
Supported in: 1.3

.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