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

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

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

Overview

A summary of information about a channel.

Instance Attribute Summary collapse

Instance Attribute Details

#channel_name ⇒ String

The name of the channel.

Returns:

  • (String) —

    The name of the channel.

#channel_storage ⇒ Types::ChannelStorageSummary

Where channel data is stored.

Returns:

#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

The last time the channel was updated.

Returns:

  • (Time) —

    The last time the channel was updated.

#status ⇒ String

The status of the channel.

Possible values:

  • CREATING
  • ACTIVE
  • DELETING

Returns:

  • (String) —

    The status of the channel.