Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTAnalytics.Types.Channel

Description

Synopsis

data Channel = Channel' {
- creationTime :: Maybe POSIX
- status :: Maybe ChannelStatus
- lastMessageArrivalTime :: Maybe POSIX
- arn :: Maybe Text
- storage :: Maybe ChannelStorage
- retentionPeriod :: Maybe RetentionPeriod
- name :: Maybe Text
- lastUpdateTime :: Maybe POSIX
}
newChannel :: Channel
channel_creationTime :: Lens' Channel (Maybe UTCTime)
channel_status :: Lens' Channel (Maybe ChannelStatus)
channel_lastMessageArrivalTime :: Lens' Channel (Maybe UTCTime)
channel_arn :: Lens' Channel (Maybe Text)
channel_storage :: Lens' Channel (Maybe ChannelStorage)
channel_retentionPeriod :: Lens' Channel (Maybe RetentionPeriod)
channel_name :: Lens' Channel (Maybe Text)
channel_lastUpdateTime :: Lens' Channel (Maybe UTCTime)

Documentation

data Channel Source #

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.

Constructors

Channel'

Fields

creationTime :: Maybe POSIX
When the channel was created.
status :: Maybe ChannelStatus
The status of the channel.
lastMessageArrivalTime :: Maybe POSIX
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.
arn :: Maybe Text
The ARN of the channel.
storage :: Maybe ChannelStorage
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.
retentionPeriod :: Maybe RetentionPeriod
How long, in days, message data is kept for the channel.
name :: Maybe Text
The name of the channel.
lastUpdateTime :: Maybe POSIX
When the channel was last updated.

Instances

Instances details

Eq Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Read Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods readsPrec :: Int -> ReadS Channel # readList :: ReadS [Channel] # readPrec :: ReadPrec Channel # readListPrec :: ReadPrec [Channel] #
Show Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods showsPrec :: Int -> Channel -> ShowS # show :: Channel -> String # showList :: [Channel] -> ShowS #
Generic Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Associated Types type Rep Channel :: Type -> Type # Methods from :: Channel -> Rep Channel x # to :: Rep Channel x -> Channel #
NFData Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods rnf :: Channel -> () #
Hashable Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods hashWithSalt :: Int -> Channel -> Int # hash :: Channel -> Int #
FromJSON Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #
type Rep Channel Source #
Instance details Defined in Amazonka.IoTAnalytics.Types.Channel type Rep Channel = D1 ('MetaData "Channel" "Amazonka.IoTAnalytics.Types.Channel" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "Channel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStatus))) :: (S1 ('MetaSel ('Just "lastMessageArrivalTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "storage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStorage)) :: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastUpdateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

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:creationTime:Channel', channel_creationTime - When the channel was created.

$sel:status:Channel', channel_status - The status of the channel.

$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:arn:Channel', channel_arn - The ARN 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.

$sel:retentionPeriod:Channel', channel_retentionPeriod - How long, in days, message data is kept for the channel.

$sel:name:Channel', channel_name - The name of the channel.

$sel:lastUpdateTime:Channel', channel_lastUpdateTime - When the channel was last updated.

channel_creationTime :: Lens' Channel (Maybe UTCTime) Source #

When the channel was created.

channel_status :: Lens' Channel (Maybe ChannelStatus) Source #

The status of the channel.

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_arn :: Lens' Channel (Maybe Text) Source #

The ARN 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.

channel_retentionPeriod :: Lens' Channel (Maybe RetentionPeriod) Source #

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

channel_name :: Lens' Channel (Maybe Text) Source #

The name of the channel.

channel_lastUpdateTime :: Lens' Channel (Maybe UTCTime) Source #

When the channel was last updated.