Skip to content

Updates the gateway virtual machine (VM) software

Description

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call describe_gateway_information to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing your Windows iSCSI settings and Customizing your Linux iSCSI settings, respectively.

Usage

storagegateway_update_gateway_software_now(GatewayARN)

Arguments

  • GatewayARN

    [required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

Value

A list with the following syntax:

list(
  GatewayARN = "string"
)

Request syntax

svc$update_gateway_software_now(
  GatewayARN = "string"
)

Examples

# Updates the gateway virtual machine (VM) software. The request
# immediately triggers the software update.
svc$update_gateway_software_now(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B"
)