Skip to content
AWS for Query.Farm

aws.iotsitewise.describe_gateway

Example SQL Queries

SELECT * FROM
aws.iotsitewise.describe_gateway
WHERE
"gateway_id" = 'VALUE';

Description

Retrieves information about a gateway.

Table Definition

Column NameColumn Data Type
gateway_id Required Input Column

The ID of the gateway device.

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
creation_date

The date the gateway was created, in Unix epoch time.

TIMESTAMP_S
gateway_arn

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} 

VARCHAR
gateway_capability_summaries

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

STRUCT(
    "capability_namespace" VARCHAR,
    "capability_sync_status" VARCHAR
)[]
Show child fields
gateway_capability_summaries[]
Show child fields
gateway_capability_summaries[].capability_namespace

The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

gateway_capability_summaries[].capability_sync_status

The synchronization status of the capability configuration. The sync status can be one of the following:

  • IN_SYNC – The gateway is running the capability configuration.

  • OUT_OF_SYNC – The gateway hasn't received the capability configuration.

  • SYNC_FAILED – The gateway rejected the capability configuration.

gateway_name

The name of the gateway.

VARCHAR
gateway_platform

The gateway's platform.

STRUCT(
    "greengrass" STRUCT(
        "group_arn" VARCHAR
    ),
    "greengrass_v2" STRUCT(
        "core_device_thing_name" VARCHAR
    ),
    "siemens_ie" STRUCT(
        "iot_core_thing_name" VARCHAR
    )
)
Show child fields
gateway_platform.greengrass

A gateway that runs on IoT Greengrass.

Show child fields
gateway_platform.greengrass.group_arn

The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.

gateway_platform.greengrass_v2

A gateway that runs on IoT Greengrass V2.

Show child fields
gateway_platform.greengrass_v2.core_device_thing_name

The name of the IoT thing for your IoT Greengrass V2 core device.

gateway_platform.siemens_ie

A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.

Show child fields
gateway_platform.siemens_ie.iot_core_thing_name

The name of the IoT Thing for your SiteWise Edge gateway.

last_update_date

The date the gateway was last updated, in Unix epoch time.

TIMESTAMP_S