StorageGateway / Client / delete_bandwidth_rate_limit

delete_bandwidth_rate_limit#

StorageGateway.Client.delete_bandwidth_rate_limit(**kwargs)#

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.

Request Syntax

response = client.delete_bandwidth_rate_limit(
    GatewayARN='string',
    BandwidthType='string'
)

Parameters:

GatewayARN (string) –
[REQUIRED]

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.
BandwidthType (string) –
[REQUIRED]

One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

Valid Values: UPLOAD | DOWNLOAD | ALL

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

(dict) –

A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.
- GatewayARN (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.

Exceptions

StorageGateway.Client.exceptions.InvalidGatewayRequestException
StorageGateway.Client.exceptions.InternalServerError

Examples

Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.

response = client.delete_bandwidth_rate_limit(
    BandwidthType='All',
    GatewayARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B',
    'ResponseMetadata': {
        '...': '...',
    },
}