gateway

Gets an individual gateway resource

Overview

Name	gateway
Type	Resource
Description	gateway
Id	awscc.iotsitewise.gateway

Fields

Name	Datatype	Description
gateway_name	string	A unique, friendly name for the gateway.
gateway_platform	object	The gateway's platform. You can only specify one platform in a gateway.
tags	array	A list of key-value pairs that contain metadata for the gateway.
gateway_id	string	The ID of the gateway device.
gateway_capability_summaries	array	A list of gateway capability summaries that each contain a namespace and status.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
gateway_name,
gateway_platform,
tags,
gateway_id,
gateway_capability_summaries
FROM awscc.iotsitewise.gateway
WHERE data__Identifier = '<GatewayId>';

Permissions

To operate on the gateway resource, the following permissions are required:

Read

iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:ListTagsForResource

Update

iotsitewise:UpdateGateway,
iotsitewise:UpdateGatewayCapabilityConfiguration,
iotsitewise:TagResource,
iotsitewise:UntagResource,
iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:ListTagsForResource

Delete

iotsitewise:DescribeGateway,
iotsitewise:DescribeGatewayCapabilityConfiguration,
iotsitewise:DeleteGateway