Channel - AWS IoT Analytics

Channel

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

Contents

arn

The ARN of the channel.

Type: String

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

When the channel was last updated.

Type: Timestamp

Required: No

name

The name of the channel.

Type: String

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

Pattern: ^[a-zA-Z0-9_]+$

Required: No

retentionPeriod

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

Type: RetentionPeriod object

Required: No

status

The status of the channel.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

storage

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.

Type: ChannelStorage object

Required: No

See Also

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