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

DescribeGatewayInformation

Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. 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 AWS Region.

Type: String

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

Required: Yes

Response Syntax


{
   "CloudWatchLogGroupARN": "string",
   "DeprecationDate": "string",
   "Ec2InstanceId": "string",
   "Ec2InstanceRegion": "string",
   "EndpointType": "string",
   "GatewayARN": "string",
   "GatewayCapacity": "string",
   "GatewayId": "string",
   "GatewayName": "string",
   "GatewayNetworkInterfaces": [ 
      { 
         "Ipv4Address": "string",
         "Ipv6Address": "string",
         "MacAddress": "string"
      }
   ],
   "GatewayState": "string",
   "GatewayTimezone": "string",
   "GatewayType": "string",
   "HostEnvironment": "string",
   "HostEnvironmentId": "string",
   "LastSoftwareUpdate": "string",
   "NextUpdateAvailabilityDate": "string",
   "SoftwareUpdatesEndDate": "string",
   "SoftwareVersion": "string",
   "SupportedGatewayCapacities": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VPCEndpoint": "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.

CloudWatchLogGroupARN

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

Type: String

Length Constraints: Maximum length of 562.

DeprecationDate

Date after which this gateway will not receive software updates for new features and bug fixes.

Type: String

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

Ec2InstanceId

The ID of the Amazon EC2 instance that was used to launch the gateway.

Type: String

Ec2InstanceRegion

The AWS Region where the Amazon EC2 instance is located.

Type: String

EndpointType

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

Type: String

Length Constraints: Minimum length of 4. Maximum length of 8.

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.

GatewayCapacity

Specifies the size of the gateway's metadata cache.

Type: String

Valid Values: Small | Medium | Large

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.

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.

Type: String

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

HostEnvironment

The type of hardware or software platform on which the gateway is running.

Note

Tape Gateway is no longer available on Snow Family devices.

Type: String

HostEnvironmentId

A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.

Type: String

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

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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM

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.

SoftwareUpdatesEndDate

Date after which this gateway will not receive software updates for new features.

Type: String

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

SoftwareVersion

The version number of the software running on the gateway appliance.

Type: String

SupportedGatewayCapacities

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Type: Array of strings

Valid Values: Small | Medium | Large

Tags

A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Type: Array of Tag objects

VPCEndpoint

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Type: String

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

Return metadata about a gateway

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_20130630.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"
}