Class: Aws::IoTAnalytics::Types::ChannelSummary

Inherits:

Struct

• Object
• Struct
• Aws::IoTAnalytics::Types::ChannelSummary

Includes:

Structure

Defined in:

lib/aws-sdk-iotanalytics/types.rb

Overview

A summary of information about a channel.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_name ⇒ String

  The name of the channel.

• #channel_storage ⇒ Types::ChannelStorageSummary

  Where channel data is stored.

• #creation_time ⇒ Time

  When the channel was created.

• #last_message_arrival_time ⇒ Time

  The last time when a new message arrived in the channel.

• #last_update_time ⇒ Time

  The last time the channel was updated.

• #status ⇒ String

  The status of the channel.

Instance Attribute Details

#channel_name ⇒ String

The name of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#channel_storage ⇒ Types::ChannelStorageSummary

Where channel data is stored.

Returns:

• (Types::ChannelStorageSummary)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

When the channel was created.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_message_arrival_time ⇒ Time

The last time when a new message arrived in the channel.

IoT Analytics updates this value at most once per minute for one channel. Hence, the ‘lastMessageArrivalTime` value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

The last time the channel was updated.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 318

class ChannelSummary < Struct.new(
  :channel_name,
  :channel_storage,
  :status,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end