You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the channel.

Returns:

  • (String) —

    The ARN of the channel.

#creation_time ⇒ Time

When the channel was created.

Returns:

  • (Time) —

    When the channel was created.

#last_message_arrival_time ⇒ Time

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

AWS 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) —

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

#last_update_time ⇒ Time

When the channel was last updated.

Returns:

  • (Time) —

    When the channel was last updated.

#name ⇒ String

The name of the channel.

Returns:

  • (String) —

    The name of the channel.

#retention_period ⇒ Types::RetentionPeriod

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

Returns:

#status ⇒ String

The status of the channel.

Possible values:

  • CREATING
  • ACTIVE
  • DELETING

Returns:

  • (String) —

    The status of the channel.

#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 cannot change this storage option after the channel is created.

Returns: