Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Channel = Channel' {}
- newChannel :: Channel
- channel_arn :: Lens' Channel (Maybe Text)
- channel_creationTime :: Lens' Channel (Maybe UTCTime)
- channel_lastMessageArrivalTime :: Lens' Channel (Maybe UTCTime)
- channel_lastUpdateTime :: Lens' Channel (Maybe UTCTime)
- channel_name :: Lens' Channel (Maybe Text)
- channel_retentionPeriod :: Lens' Channel (Maybe RetentionPeriod)
- channel_status :: Lens' Channel (Maybe ChannelStatus)
- channel_storage :: Lens' Channel (Maybe ChannelStorage)
Documentation
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.
See: newChannel
smart constructor.
Channel' | |
|
Instances
newChannel :: Channel Source #
Create a value of Channel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Channel'
, channel_arn
- The ARN of the channel.
$sel:creationTime:Channel'
, channel_creationTime
- When the channel was created.
$sel:lastMessageArrivalTime:Channel'
, channel_lastMessageArrivalTime
- The last time when a new message arrived in the channel.
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.
$sel:lastUpdateTime:Channel'
, channel_lastUpdateTime
- When the channel was last updated.
$sel:name:Channel'
, channel_name
- The name of the channel.
$sel:retentionPeriod:Channel'
, channel_retentionPeriod
- How long, in days, message data is kept for the channel.
$sel:status:Channel'
, channel_status
- The status of the channel.
$sel:storage:Channel'
, channel_storage
- Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3
storage. If not specified, the default is
serviceManagedS3
. You can't change this storage option after the
channel is created.
channel_lastMessageArrivalTime :: Lens' Channel (Maybe UTCTime) Source #
The last time when a new message arrived in the channel.
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.
channel_retentionPeriod :: Lens' Channel (Maybe RetentionPeriod) Source #
How long, in days, message data is kept for the channel.
channel_status :: Lens' Channel (Maybe ChannelStatus) Source #
The status of the channel.
channel_storage :: Lens' Channel (Maybe ChannelStorage) Source #
Where channel data is stored. You can choose one of serviceManagedS3
or customerManagedS3
storage. If not specified, the default is
serviceManagedS3
. You can't change this storage option after the
channel is created.