AWS Storage Gateway
User Guide (API Version 2012-06-30)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

StartGateway

Description

This operation starts a gateway that you previously shut down (see ShutdownGateway. After the gateway starts, you can now 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 get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call Describe Gateway 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

POST / HTTP/1.1 
Host: storagegateway.region.amazonaws.com
Authorization: authorization
Content-Type: application/x-amz-json-1.1
x-amz-date: date
x-amz-target: StorageGateway_20120630.StartGateway

{
   "GatewayARN": "String"
}

JSON Fields

GatewayARN

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

Required: yes

Type: String

Response

Syntax

HTTP/1.1 200 OK
x-amzn-RequestId: x-amzn-RequestId
Content-Type: application/x-amz-json-1.1
Content-length: payloadLength
Date: date

{
 "GatewayARN": "String"
}

JSON Fields

GatewayARN

The Amazon Resource Name (ARN) of the gateway that was restarted.

Type: String

Errors

This operation returns the following error codes in addition to exceptions common to all operations. For information about these errors and common exceptions, see Error Responses.

  • GatewayInternalError

  • GatewayNotConnected

  • GatewayNotFound

  • GatewayProxyNetworkConnectionBusy

  • InternalError

  • InvalidParameters

  • NotSupported

Examples

Example Request

The following example shows a request that starts a gateway.

POST / HTTP/1.1 
Host: storagegateway.us-east-1.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.StartGateway

{
   "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
}

Example Response

HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 85

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway"
}