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.CreateChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Used to create a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

Synopsis

data CreateChannel = CreateChannel' {
- retentionPeriod :: Maybe RetentionPeriod
- channelStorage :: Maybe ChannelStorage
- tags :: Maybe (NonEmpty Tag)
- channelName :: Text
}
newCreateChannel :: Text -> CreateChannel
createChannel_retentionPeriod :: Lens' CreateChannel (Maybe RetentionPeriod)
createChannel_channelStorage :: Lens' CreateChannel (Maybe ChannelStorage)
createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag))
createChannel_channelName :: Lens' CreateChannel Text
data CreateChannelResponse = CreateChannelResponse' {
- channelArn :: Maybe Text
- retentionPeriod :: Maybe RetentionPeriod
- channelName :: Maybe Text
- httpStatus :: Int
}
newCreateChannelResponse :: Int -> CreateChannelResponse
createChannelResponse_channelArn :: Lens' CreateChannelResponse (Maybe Text)
createChannelResponse_retentionPeriod :: Lens' CreateChannelResponse (Maybe RetentionPeriod)
createChannelResponse_channelName :: Lens' CreateChannelResponse (Maybe Text)
createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int

Creating a Request

data CreateChannel Source #

See: newCreateChannel smart constructor.

Constructors

CreateChannel'

Fields

retentionPeriod :: Maybe RetentionPeriod
How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.
channelStorage :: 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.
tags :: Maybe (NonEmpty Tag)
Metadata which can be used to manage the channel.
channelName :: Text
The name of the channel.

Instances

Instances details

Eq CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods (==) :: CreateChannel -> CreateChannel -> Bool # (/=) :: CreateChannel -> CreateChannel -> Bool #
Read CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods readsPrec :: Int -> ReadS CreateChannel # readList :: ReadS [CreateChannel] # readPrec :: ReadPrec CreateChannel # readListPrec :: ReadPrec [CreateChannel] #
Show CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods showsPrec :: Int -> CreateChannel -> ShowS # show :: CreateChannel -> String # showList :: [CreateChannel] -> ShowS #
Generic CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Associated Types type Rep CreateChannel :: Type -> Type # Methods from :: CreateChannel -> Rep CreateChannel x # to :: Rep CreateChannel x -> CreateChannel #
NFData CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods rnf :: CreateChannel -> () #
Hashable CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods hashWithSalt :: Int -> CreateChannel -> Int # hash :: CreateChannel -> Int #
ToJSON CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods toJSON :: CreateChannel -> Value # toEncoding :: CreateChannel -> Encoding # toJSONList :: [CreateChannel] -> Value # toEncodingList :: [CreateChannel] -> Encoding #
AWSRequest CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Associated Types type AWSResponse CreateChannel # Methods request :: CreateChannel -> Request CreateChannel # response :: MonadResource m => Logger -> Service -> Proxy CreateChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateChannel))) #
ToHeaders CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods toHeaders :: CreateChannel -> [Header] #
ToPath CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods toPath :: CreateChannel -> ByteString #
ToQuery CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods toQuery :: CreateChannel -> QueryString #
type Rep CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel type Rep CreateChannel = D1 ('MetaData "CreateChannel" "Amazonka.IoTAnalytics.CreateChannel" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "CreateChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)) :: S1 ('MetaSel ('Just "channelStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelStorage))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateChannel Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel type AWSResponse CreateChannel = CreateChannelResponse

newCreateChannel Source #

Arguments

:: Text	`$sel:channelName:CreateChannel'`
-> CreateChannel

Create a value of CreateChannel 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:retentionPeriod:CreateChannel', createChannel_retentionPeriod - How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

$sel:channelStorage:CreateChannel', createChannel_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.

$sel:tags:CreateChannel', createChannel_tags - Metadata which can be used to manage the channel.

$sel:channelName:CreateChannel', createChannel_channelName - The name of the channel.

Request Lenses

createChannel_retentionPeriod :: Lens' CreateChannel (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the channel. When customerManagedS3 storage is selected, this parameter is ignored.

createChannel_channelStorage :: Lens' CreateChannel (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.

createChannel_tags :: Lens' CreateChannel (Maybe (NonEmpty Tag)) Source #

Metadata which can be used to manage the channel.

createChannel_channelName :: Lens' CreateChannel Text Source #

The name of the channel.

Destructuring the Response

data CreateChannelResponse Source #

See: newCreateChannelResponse smart constructor.

Constructors

CreateChannelResponse'
Fields channelArn :: Maybe Text The ARN of the channel. retentionPeriod :: Maybe RetentionPeriod How long, in days, message data is kept for the channel. channelName :: Maybe Text The name of the channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods (==) :: CreateChannelResponse -> CreateChannelResponse -> Bool # (/=) :: CreateChannelResponse -> CreateChannelResponse -> Bool #
Read CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods readsPrec :: Int -> ReadS CreateChannelResponse # readList :: ReadS [CreateChannelResponse] # readPrec :: ReadPrec CreateChannelResponse # readListPrec :: ReadPrec [CreateChannelResponse] #
Show CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods showsPrec :: Int -> CreateChannelResponse -> ShowS # show :: CreateChannelResponse -> String # showList :: [CreateChannelResponse] -> ShowS #
Generic CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Associated Types type Rep CreateChannelResponse :: Type -> Type # Methods from :: CreateChannelResponse -> Rep CreateChannelResponse x # to :: Rep CreateChannelResponse x -> CreateChannelResponse #
NFData CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel Methods rnf :: CreateChannelResponse -> () #
type Rep CreateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.CreateChannel type Rep CreateChannelResponse = D1 ('MetaData "CreateChannelResponse" "Amazonka.IoTAnalytics.CreateChannel" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "CreateChannelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod))) :: (S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))