Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

DescribeGatewayInformation

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

Request Syntax

{
   "GatewayARN": "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.

GatewayARN

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

Type: String

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

Required: Yes

Response Syntax

{
   "GatewayARN": "string",
   "GatewayId": "string",
   "GatewayName": "string",
   "GatewayNetworkInterfaces": [ 
      { 
         "Ipv4Address": "string",
         "Ipv6Address": "string",
         "MacAddress": "string"
      }
   ],
   "GatewayState": "string",
   "GatewayTimezone": "string",
   "GatewayType": "string",
   "LastSoftwareUpdate": "string",
   "NextUpdateAvailabilityDate": "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 region.

Type: String

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

GatewayId

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 30.

GatewayName

The name you configured for your gateway.

Type: String

GatewayNetworkInterfaces

A NetworkInterface array that contains descriptions of the gateway network interfaces.

Type: Array of NetworkInterface objects

GatewayState

A value that indicates the operating state of the gateway.

Type: String

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

GatewayTimezone

A value that indicates the time zone configured for the gateway.

Type: String

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

GatewayType

The type of the gateway.

Type: String

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

LastSoftwareUpdate

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

Type: String

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

NextUpdateAvailabilityDate

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

Type: String

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

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

Example

Example Request

The following example shows a request for describing 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_20120630.DescribeGatewayInformation
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B"
}
               

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: 227
{
   "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B",
   "GatewayId": "sgw-AABB1122",
   "GatewayNetworkInterfaces": [ {"Ipv4Address": "10.35.69.216"} ],
   "GatewayState": "STATE_RUNNING",
   "GatewayTimezone": "GMT-8:00",
   "LastSoftwareUpdate": "2015-01-02T16:00:00",
   "NextUpdateAvailabilityDate": "2016-01-02T16:00:00"

}
               

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: