Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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.

post/#X-Amz-Target=StorageGateway_20130630.DescribeGatewayInformation

Headers

X-Amz-Target'StorageGateway_20130630.DescribeGatewayInformation' required

Request body

GatewayARNstring required

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

Response

Success

GatewayARNstring

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

GatewayIdstring

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.

GatewayNamestring

The name you configured for your gateway.

GatewayTimezonestring

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

GatewayStatestring

A value that indicates the operating state of the gateway.

GatewayTypestring

The type of the gateway.

NextUpdateAvailabilityDatestring

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.

LastSoftwareUpdatestring

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

Ec2InstanceIdstring

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

Ec2InstanceRegionstring

The Amazon Web Services Region where the Amazon EC2 instance is located.

VPCEndpointstring

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

CloudWatchLogGroupARNstring

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

HostEnvironment'VMWARE' | 'HYPER-V' | 'EC2' | 'KVM' | 'OTHER' | 'SNOWBALL'

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

EndpointTypestring
<p>The type of endpoint for your gateway.</p> <p>Valid Values: <code>STANDARD</code> | <code>FIPS</code> </p>
SoftwareUpdatesEndDatestring

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

DeprecationDatestring

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

GatewayCapacity'Small' | 'Medium' | 'Large'

Specifies the size of the gateway's metadata cache.

SupportedGatewayCapacitiesGatewayCapacity[]

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

HostEnvironmentIdstring

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.

Example response

{
  "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  "GatewayId": "sgw-AABB1122",
  "GatewayName": "My_Gateway",
  "GatewayNetworkInterfaces": [
    {
      "Ipv4Address": "10.35.69.216"
    }
  ],
  "GatewayState": "STATE_RUNNING",
  "GatewayTimezone": "GMT-8:00",
  "GatewayType": "STORED",
  "LastSoftwareUpdate": "2016-01-02T16:00:00",
  "NextUpdateAvailabilityDate": "2017-01-02T16:00:00"
}