GatewaySummary - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GatewaySummary

Contains a summary of a gateway.

Contents

creationDate

The date the gateway was created, 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

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 asset.

Type: String

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

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

Required: Yes

gatewayPlatform

Contains a gateway's platform information.

Type: GatewayPlatform object

Required: No

lastUpdateDate

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

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: