| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.StorageGateway.ShutdownGateway
Description
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 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.
Synopsis
- data ShutdownGateway = ShutdownGateway' {
- gatewayARN :: Text
- newShutdownGateway :: Text -> ShutdownGateway
- shutdownGateway_gatewayARN :: Lens' ShutdownGateway Text
- data ShutdownGatewayResponse = ShutdownGatewayResponse' {
- gatewayARN :: Maybe Text
- httpStatus :: Int
- newShutdownGatewayResponse :: Int -> ShutdownGatewayResponse
- shutdownGatewayResponse_gatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text)
- shutdownGatewayResponse_httpStatus :: Lens' ShutdownGatewayResponse Int
Creating a Request
data ShutdownGateway Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.
See: newShutdownGateway smart constructor.
Constructors
| ShutdownGateway' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ShutdownGateway |
Create a value of ShutdownGateway with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ShutdownGateway', shutdownGateway_gatewayARN - Undocumented member.
Request Lenses
shutdownGateway_gatewayARN :: Lens' ShutdownGateway Text Source #
Undocumented member.
Destructuring the Response
data ShutdownGatewayResponse Source #
A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.
See: newShutdownGatewayResponse smart constructor.
Constructors
| ShutdownGatewayResponse' | |
Fields
| |
Instances
newShutdownGatewayResponse Source #
Create a value of ShutdownGatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gatewayARN:ShutdownGateway', shutdownGatewayResponse_gatewayARN - Undocumented member.
$sel:httpStatus:ShutdownGatewayResponse', shutdownGatewayResponse_httpStatus - The response's http status code.
Response Lenses
shutdownGatewayResponse_gatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text) Source #
Undocumented member.
shutdownGatewayResponse_httpStatus :: Lens' ShutdownGatewayResponse Int Source #
The response's http status code.