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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the channel.

Returns:

  • (String)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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_timeTime

When the channel was created.

Returns:

  • (Time)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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_timeTime

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)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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_timeTime

When the channel was last updated.

Returns:

  • (Time)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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

#nameString

The name of the channel.

Returns:

  • (String)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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_periodTypes::RetentionPeriod

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



209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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

#statusString

The status of the channel.

Returns:

  • (String)


209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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

#storageTypes::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.



209
210
211
212
213
214
215
216
217
218
219
220
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 209

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