ChannelSummary - AWS IoT Analytics

ChannelSummary

A summary of information about a channel.

Contents

channelName

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: No

channelStorage

Where channel data is stored.

Type: ChannelStorageSummary object

Required: No

creationTime

When the channel was created.

Type: Timestamp

Required: No

lastMessageArrivalTime

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.

Type: Timestamp

Required: No

lastUpdateTime

The last time the channel was updated.

Type: Timestamp

Required: No

status

The status of the channel.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: