AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . storagegateway ]

describe-gateway-information

Description

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.

See also: AWS API Documentation

Synopsis

  describe-gateway-information
--gateway-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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.

Warning

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 .

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. 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

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. 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 -> (string)

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

Note

Tape Gateway is no longer available on Snow Family devices.

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)

HostEnvironmentId -> (string)

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.

SoftwareVersion -> (string)

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