StorageGateway / Client / start_gateway

start_gateway#

StorageGateway.Client.start_gateway(**kwargs)#

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway’s storage volumes and you will be able to take snapshot backups.

Note

When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

response = client.start_gateway(
    GatewayARN='string'
)

Parameters:

GatewayARN (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

(dict) –

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was restarted.
- GatewayARN (string) –
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Exceptions

Examples

Starts a gateway service that was previously shut down.

response = client.start_gateway(
    GatewayARN='arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
)

print(response)

Expected Output:

{
    'GatewayARN': 'arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B',
    'ResponseMetadata': {
        '...': '...',
    },
}