| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.StorageGateway.ShutdownGateway
Description
This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the 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.
See: AWS API Reference for ShutdownGateway.
- shutdownGateway :: Text -> ShutdownGateway
- data ShutdownGateway
- sGatewayARN :: Lens' ShutdownGateway Text
- shutdownGatewayResponse :: Int -> ShutdownGatewayResponse
- data ShutdownGatewayResponse
- srsGatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text)
- srsResponseStatus :: Lens' ShutdownGatewayResponse Int
Creating a Request
Arguments
| :: Text | |
| -> ShutdownGateway |
Creates a value of ShutdownGateway with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ShutdownGateway Source
A JSON object containing the of the gateway to shut down.
See: shutdownGateway smart constructor.
Instances
Request Lenses
sGatewayARN :: Lens' ShutdownGateway Text Source
Undocumented member.
Destructuring the Response
shutdownGatewayResponse Source
Arguments
| :: Int | |
| -> ShutdownGatewayResponse |
Creates a value of ShutdownGatewayResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ShutdownGatewayResponse Source
A JSON object containing the of the gateway that was shut down.
See: shutdownGatewayResponse smart constructor.
Response Lenses
srsGatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text) Source
Undocumented member.
srsResponseStatus :: Lens' ShutdownGatewayResponse Int Source
The response status code.