Skip to content
AWS for Query.Farm

aws.storagegateway.describe_gateway_information

Example SQL Queries

SELECT * FROM
aws.storagegateway.describe_gateway_information
WHERE
"gateway_arn" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
gateway_arn Required Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
cloud_watch_log_group_arn

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

VARCHAR
deprecation_date

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

VARCHAR
ec2_instance_id

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

VARCHAR
ec2_instance_region

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

VARCHAR
endpoint_type

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS 

VARCHAR
gateway_capacity

Specifies the size of the gateway's metadata cache.

VARCHAR
gateway_id

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.

VARCHAR
gateway_name

The name you configured for your gateway.

VARCHAR
gateway_network_interfaces

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

STRUCT(
    "ipv4_address" VARCHAR,
    "mac_address" VARCHAR,
    "ipv6_address" VARCHAR
)[]
Show child fields
gateway_network_interfaces[]
Show child fields
gateway_network_interfaces[].ipv4_address

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

gateway_network_interfaces[].ipv6_address

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

gateway_network_interfaces[].mac_address

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

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

gateway_state

A value that indicates the operating state of the gateway.

VARCHAR
gateway_timezone

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

VARCHAR
gateway_type

The type of the gateway.

VARCHAR
host_environment

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

Tape Gateway is no longer available on Snow Family devices.

VARCHAR
host_environment_id

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.

VARCHAR
last_software_update

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

VARCHAR
next_update_availability_date

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.

VARCHAR
software_updates_end_date

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

VARCHAR
software_version

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

VARCHAR
supported_gateway_capacities

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

VARCHAR[]
Show child fields
supported_gateway_capacities[]
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.

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

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

tags[].value

Value of the tag key.

vpc_endpoint

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

VARCHAR