Skip to content
AWS for Query.Farm

aws.backup_gateway.get_gateway

Example SQL Queries

SELECT * FROM
aws.backup_gateway.get_gateway
WHERE
"gateway_arn" = 'VALUE';

Description

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Table Definition

Column NameColumn Data Type
gateway_arn Required Input Column

The Amazon Resource Name (ARN) of the gateway.

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
gateway

By providing the ARN (Amazon Resource Name), this API returns the gateway.

STRUCT(
    "gateway_arn" VARCHAR,
    "gateway_display_name" VARCHAR,
    "gateway_type" VARCHAR,
    "hypervisor_id" VARCHAR,
    "last_seen_time" TIMESTAMP_S,
    "maintenance_start_time" STRUCT(
        "day_of_month" BIGINT,
        "day_of_week" BIGINT,
        "hour_of_day" BIGINT,
        "minute_of_hour" BIGINT
    ),
    "next_update_availability_time" TIMESTAMP_S,
    "vpc_endpoint" VARCHAR
)
Show child fields
gateway.gateway_arn

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.

gateway.gateway_display_name

The display name of the gateway.

gateway.gateway_type

The type of the gateway type.

gateway.hypervisor_id

The hypervisor ID of the gateway.

gateway.last_seen_time

Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

gateway.maintenance_start_time

Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

Show child fields
gateway.maintenance_start_time.day_of_month

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

gateway.maintenance_start_time.day_of_week

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

gateway.maintenance_start_time.hour_of_day

The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

gateway.maintenance_start_time.minute_of_hour

The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

gateway.next_update_availability_time

Details showing the next update availability time of the gateway.

gateway.vpc_endpoint

The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.