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

Amazonka.IoTAnalytics.UpdateChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Used to update the settings of a channel.

Creating a Request

data UpdateChannel Source #

See: newUpdateChannel smart constructor.

Constructors

UpdateChannel'

Fields

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.
retentionPeriod :: Maybe RetentionPeriod
How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.
channelName :: Text
The name of the channel to be updated.

Instances

Instances details

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

newUpdateChannel Source #

Arguments

:: Text	`UpdateChannel`
-> UpdateChannel

Create a value of UpdateChannel 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:

UpdateChannel, updateChannel_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.

UpdateChannel, updateChannel_retentionPeriod - How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.

UpdateChannel, updateChannel_channelName - The name of the channel to be updated.

Request Lenses

updateChannel_channelStorage :: Lens' UpdateChannel (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.

updateChannel_retentionPeriod :: Lens' UpdateChannel (Maybe RetentionPeriod) Source #

How long, in days, message data is kept for the channel. The retention period can't be updated if the channel's Amazon S3 storage is customer-managed.

updateChannel_channelName :: Lens' UpdateChannel Text Source #

The name of the channel to be updated.

Destructuring the Response

data UpdateChannelResponse Source #

See: newUpdateChannelResponse smart constructor.

Constructors

UpdateChannelResponse'

Instances

Instances details

Generic UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel Associated Types type Rep UpdateChannelResponse :: Type -> Type # Methods from :: UpdateChannelResponse -> Rep UpdateChannelResponse x # to :: Rep UpdateChannelResponse x -> UpdateChannelResponse #
Read UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel Methods readsPrec :: Int -> ReadS UpdateChannelResponse # readList :: ReadS [UpdateChannelResponse] # readPrec :: ReadPrec UpdateChannelResponse # readListPrec :: ReadPrec [UpdateChannelResponse] #
Show UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel Methods showsPrec :: Int -> UpdateChannelResponse -> ShowS # show :: UpdateChannelResponse -> String # showList :: [UpdateChannelResponse] -> ShowS #
NFData UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel Methods rnf :: UpdateChannelResponse -> () #
Eq UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel Methods (==) :: UpdateChannelResponse -> UpdateChannelResponse -> Bool # (/=) :: UpdateChannelResponse -> UpdateChannelResponse -> Bool #
type Rep UpdateChannelResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.UpdateChannel type Rep UpdateChannelResponse = D1 ('MetaData "UpdateChannelResponse" "Amazonka.IoTAnalytics.UpdateChannel" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "UpdateChannelResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateChannelResponse :: UpdateChannelResponse Source #

Create a value of UpdateChannelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.