Class: Aws::IoTAnalytics::Types::Channel

Inherits:

Struct

• Object
• Struct
• Aws::IoTAnalytics::Types::Channel

Defined in:

gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb

Overview

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the channel.

• #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

  When the channel was last updated.

• #name ⇒ String

  The name of the channel.

• #retention_period ⇒ Types::RetentionPeriod

  How long, in days, message data is kept for the channel.

• #status ⇒ String

  The status of the channel.

• #storage ⇒ Types::ChannelStorage

  Where channel data is stored.

Instance Attribute Details

#arn ⇒ String

The ARN of the channel.

Returns:

• (String)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :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 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 177

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :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 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 177

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_time ⇒ Time

When the channel was last updated.

Returns:

• (Time)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the channel.

Returns:

• (String)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#retention_period ⇒ Types::RetentionPeriod

How long, in days, message data is kept for the channel.

Returns:

• (Types::RetentionPeriod)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the channel.

Returns:

• (String)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end

#storage ⇒ Types::ChannelStorage

Where channel data is stored. You can choose one of serviceManagedS3 or customerManagedS3 storage. If not specified, the default is serviceManagedS3. You can't change this storage option after the channel is created.

Returns:

• (Types::ChannelStorage)

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

class Channel < Struct.new(
  :name,
  :storage,
  :arn,
  :status,
  :retention_period,
  :creation_time,
  :last_update_time,
  :last_message_arrival_time)
  SENSITIVE = []
  include Aws::Structure
end