Description Usage Arguments Value Request syntax Examples
View source: R/storagegateway_operations.R
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
start_gateway
,
describe_gateway_information
,
and list_gateways
. For more
information, see activate_gateway
.
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
describe_gateway_information
API to check the status. For more information, see
activate_gateway
.
If do not intend to use the gateway again, you must delete the gateway
(using delete_gateway
) to no longer
pay software charges associated with the gateway.
1 | storagegateway_shutdown_gateway(GatewayARN)
|
GatewayARN |
[required] |
A list with the following syntax:
1 2 3 | list(
GatewayARN = "string"
)
|
1 2 3 | svc$shutdown_gateway(
GatewayARN = "string"
)
|
1 2 3 4 5 6 7 8 | ## Not run:
# This operation shuts down the gateway service component running in the
# storage gateway's virtual machine (VM) and not the VM.
svc$shutdown_gateway(
GatewayARN = "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B"
)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.