[ aws . iotsitewise ]

describe-gateway

Description

Retrieves information about a gateway.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--gateway-id (string)

The ID of the gateway device.

--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 example describes a gateway.

aws iotsitewise describe-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE

Output:

{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayName": "ExampleCorpGateway",
    "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayPlatform": {
        "greengrass": {
            "groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE"
        }
    },
    "gatewayCapabilitySummaries": [
        {
            "capabilityNamespace": "iotsitewise:opcuacollector:1",
            "capabilitySyncStatus": "IN_SYNC"
        }
    ],
    "creationDate": 1588369971.457,
    "lastUpdateDate": 1588369971.457
}

For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.

Output

gatewayId -> (string)

The ID of the gateway device.

gatewayName -> (string)

The name of the gateway.

gatewayArn -> (string)

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

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

gatewayPlatform -> (structure)

The gateway’s platform.

greengrass -> (structure)

A gateway that runs on AWS IoT Greengrass.

groupArn -> (string)

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

gatewayCapabilitySummaries -> (list)

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 .

(structure)

Contains a summary of a gateway capability configuration.

capabilityNamespace -> (string)

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

capabilitySyncStatus -> (string)

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.

creationDate -> (timestamp)

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

lastUpdateDate -> (timestamp)

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