Skip to main content

gateways_list_only

Lists gateways in a region or regions, for all properties use gateways

Overview

Namegateways_list_only
TypeResource
DescriptionResource schema for AWS::IoTSiteWise::Gateway
Idaws.iotsitewise.gateways_list_only

Fields

NameDatatypeDescription
gateway_namestringA unique, friendly name for the gateway.
gateway_platformobjectThe gateway's platform. You can only specify one platform in a gateway.
tagsarrayA list of key-value pairs that contain metadata for the gateway.
gateway_idstringThe ID of the gateway device.
gateway_capability_summariesarrayA list of gateway capability summaries that each contain a namespace and status.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all gateways in a region.

SELECT
region,
gateway_id
FROM aws.iotsitewise.gateways_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the gateways_list_only resource, see gateways