GatewaySummary

Contains a summary of a gateway.

creationDate

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

Type: Timestamp

Required: Yes

gatewayId

The ID of the gateway device.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

gatewayName

The name of the gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

Required: Yes

lastUpdateDate

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

Type: Timestamp

Required: Yes

gatewayCapabilitySummaries

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.

Type: Array of GatewayCapabilitySummary objects

Required: No

gatewayPlatform

The gateway's platform configuration. You can only specify one platform type in a gateway.

(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.

For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.

For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.

Type: GatewayPlatform object

Required: No

gatewayVersion

The version of the gateway. Options include:

2 - Classic streams, V2 gateway.
3 - MQTT-enabled, V3 gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[0-9]+$

Required: No

GatewaySummary

Contents

See Also