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.
Parameters:
-
bandwidth_type
(BandwidthType)
–
One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.
Valid Values: UPLOAD | DOWNLOAD | ALL
Raises:
-
InternalServerError
–
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.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Examples:
To delete bandwidth rate limits of gateway
Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
>>> await client.delete_bandwidth_rate_limit(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B', bandwidth_type='All')
Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py
| async def delete_bandwidth_rate_limit(
self,
gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
bandwidth_type: "capo_storage_gateway.types.bandwidth_type.BandwidthType",
*,
config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.delete_bandwidth_rate_limit_output.DeleteBandwidthRateLimitOutput":
"""<p>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.</p>
Args:
bandwidth_type: <p>One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.</p> <p>Valid Values: <code>UPLOAD</code> | <code>DOWNLOAD</code> | <code>ALL</code> </p>
Raises:
capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To delete bandwidth rate limits of gateway
Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.
>>> await client.delete_bandwidth_rate_limit(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B', bandwidth_type='All')
"""
async def _handler(
req: "AsyncOperationRequest[capo_storage_gateway.types.delete_bandwidth_rate_limit_input.DeleteBandwidthRateLimitInput]",
) -> AsyncOperationResponse[
"capo_storage_gateway.types.delete_bandwidth_rate_limit_output.DeleteBandwidthRateLimitOutput"
]:
import capo_storage_gateway._operations.storage_gateway_20130630.delete_bandwidth_rate_limit
(
output,
http_response,
) = await capo_storage_gateway._operations.storage_gateway_20130630.delete_bandwidth_rate_limit.async_delete_bandwidth_rate_limit(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteBandwidthRateLimit")
)
input_: capo_storage_gateway.types.delete_bandwidth_rate_limit_input.DeleteBandwidthRateLimitInput = {
"gateway_arn": gateway_arn,
"bandwidth_type": bandwidth_type,
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|