Class: Aws::IoTSiteWise::Types::GatewaySummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::GatewaySummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Overview

Contains a summary of a gateway.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

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

• #gateway_capability_summaries ⇒ Array<Types::GatewayCapabilitySummary>

  A list of gateway capability summaries that each contain a namespace and status.

• #gateway_id ⇒ String

  The ID of the gateway device.

• #gateway_name ⇒ String

  The name of the gateway.

• #gateway_platform ⇒ Types::GatewayPlatform

  The gateway’s platform configuration.

• #gateway_version ⇒ String

  The version of the gateway.

• #last_update_date ⇒ Time

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

Instance Attribute Details

#creation_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_capability_summaries ⇒ Array<Types::GatewayCapabilitySummary>

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

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html

Returns:

• (Array<Types::GatewayCapabilitySummary>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_id ⇒ String

The ID of the gateway device.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_name ⇒ String

The name of the gateway.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_platform ⇒ Types::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.

Returns:

• (Types::GatewayPlatform)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_version ⇒ String

The version of the gateway. A value of ‘3` indicates an MQTT-enabled, V3 gateway, while `2` indicates a Classic streams, V2 gateway.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 6815

class GatewaySummary < Struct.new(
  :gateway_id,
  :gateway_name,
  :gateway_platform,
  :gateway_version,
  :gateway_capability_summaries,
  :creation_date,
  :last_update_date)
  SENSITIVE = []
  include Aws::Structure
end