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.
Shuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down,
use the Amazon Resource Name (ARN) of the gateway in the body of your request.
This API action cannot be used to shut down S3 File Gateway or FSx File Gateway.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK success response immediately.
However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation
API to check the status. For more information, see ActivateGateway.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginShutdownGateway and EndShutdownGateway.
Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z
public virtual Task<ShutdownGatewayResponse> ShutdownGatewayAsync( ShutdownGatewayRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the ShutdownGateway service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5