describe-gateway-information¶

Description¶

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.

Synopsis¶

  describe-gateway-information
--gateway-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--gateway-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe a gateway

The following describe-gateway-information command returns metadata about the specified gateway. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in the command.

This examples specifies a gateway with the id sgw-12A3456B in account 123456789012:

aws storagegateway describe-gateway-information --gateway-arn "arn:aws:storagegateway:us-west-2:123456789012:gateway/sgw-12A3456B"

This command outputs a JSON block that contains metadata about about the gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).

Output¶

GatewayARN -> (string)

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

GatewayId -> (string)

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.

GatewayName -> (string)

The name you configured for your gateway.

GatewayTimezone -> (string)

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

GatewayState -> (string)

A value that indicates the operating state of the gateway.

GatewayNetworkInterfaces -> (list)

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

(structure)

Describes a gateway’s network interface.

Ipv4Address -> (string)

The Internet Protocol version 4 (IPv4) address of the interface.

MacAddress -> (string)

The Media Access Control (MAC) address of the interface.

Note

This is currently unsupported and will not be returned in output.

Ipv6Address -> (string)

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported .

GatewayType -> (string)

The type of the gateway.

NextUpdateAvailabilityDate -> (string)

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.

LastSoftwareUpdate -> (string)

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.

Ec2InstanceId -> (string)

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

Ec2InstanceRegion -> (string)

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

Tags -> (list)

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.

(structure)

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

Key -> (string)

Tag key. The key can’t start with aws:.

Value -> (string)

Value of the tag key.

VPCEndpoint -> (string)

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

CloudWatchLogGroupARN -> (string)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.

HostEnvironment -> (string)

The type of hypervisor environment used by the host.

EndpointType -> (string)

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

SoftwareUpdatesEndDate -> (string)

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

DeprecationDate -> (string)

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

GatewayCapacity -> (string)

Specifies the size of the gateway’s metadata cache.

SupportedGatewayCapacities -> (list)

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

(string)

Table of Contents

Feedback

User Guide