Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ActivateGateway

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account. For more information, see UpdateGatewayInformation.

Note

You must turn on the gateway VM before you can activate your gateway.

Request Syntax


{
   "ActivationKey": "string",
   "GatewayName": "string",
   "GatewayRegion": "string",
   "GatewayTimezone": "string",
   "GatewayType": "string",
   "MediumChangerType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TapeDriveType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ActivationKey

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes

GatewayName

The name you configured for your gateway.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 255.

Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$

Required: Yes

GatewayRegion

A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the AWS General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25.

Required: Yes

GatewayTimezone

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, GMT indicates Greenwich Mean Time without any offset. GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 10.

Required: Yes

GatewayType

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Important

Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB

Type: String

Length Constraints: Minimum length of 2. Maximum length of 20.

Required: No

MediumChangerType

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Type: String

Length Constraints: Minimum length of 2. Maximum length of 50.

Required: No

Tags

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Note

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Type: Array of Tag objects

Required: No

TapeDriveType

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Type: String

Length Constraints: Minimum length of 2. Maximum length of 50.

Required: No

Response Syntax


{
   "GatewayARN": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GatewayARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Examples

Activate a gateway

The following example shows a request that activates a gateway.

Sample Request


POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
x-amz-Date: 20120425T120000Z
Authorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Content-type: application/x-amz-json-1.1
x-amz-target: StorageGateway_20130630.ActivateGateway

{
   "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
   "GatewayName": "mygateway",
   "GatewayTimezone": "GMT-12:00",
   "GatewayRegion": "us-east-2",
   "GatewayType": "STORED",
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG
Date: Wed, 25 Apr 2012 12:00:02 GMT
Content-type: application/x-amz-json-1.1
Content-length: 80

{
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-11A2222B"
}