AWS IoT Analytics
AWS IoT Analytics Documentation (API Version 2017-11-27)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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

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 may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.

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:

On this page: