AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::IoTSiteWise::Types::DescribeGatewayResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

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

Returns:

  • (Time)


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#gateway_arnString

The ARN of the gateway, which has the following format.

arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:gateway/$\{GatewayId\}

Returns:

  • (String)


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#gateway_capability_summariesArray<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.



3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#gateway_idString

The ID of the gateway device.

Returns:

  • (String)


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#gateway_nameString

The name of the gateway.

Returns:

  • (String)


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#gateway_platformTypes::GatewayPlatform

The gateway's platform.



3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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

#last_update_dateTime

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

Returns:

  • (Time)


3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 3032

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