Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Kinesis.DecreaseStreamRetentionPeriod

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

Synopsis

Creating a Request

decreaseStreamRetentionPeriod #

Arguments

:: Text	`dsrpStreamName`
-> Natural	`dsrpRetentionPeriodHours`
-> DecreaseStreamRetentionPeriod

Creates a value of DecreaseStreamRetentionPeriod with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsrpStreamName - The name of the stream to modify.
dsrpRetentionPeriodHours - The new retention period of the stream, in hours. Must be less than the current retention period.

data DecreaseStreamRetentionPeriod #

Represents the input for DecreaseStreamRetentionPeriod .

See: decreaseStreamRetentionPeriod smart constructor.

Instances

Eq DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods (==) :: DecreaseStreamRetentionPeriod -> DecreaseStreamRetentionPeriod -> Bool # (/=) :: DecreaseStreamRetentionPeriod -> DecreaseStreamRetentionPeriod -> Bool #
Data DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DecreaseStreamRetentionPeriod -> c DecreaseStreamRetentionPeriod # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DecreaseStreamRetentionPeriod # toConstr :: DecreaseStreamRetentionPeriod -> Constr # dataTypeOf :: DecreaseStreamRetentionPeriod -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DecreaseStreamRetentionPeriod) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DecreaseStreamRetentionPeriod) # gmapT :: (forall b. Data b => b -> b) -> DecreaseStreamRetentionPeriod -> DecreaseStreamRetentionPeriod # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DecreaseStreamRetentionPeriod -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DecreaseStreamRetentionPeriod -> r # gmapQ :: (forall d. Data d => d -> u) -> DecreaseStreamRetentionPeriod -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DecreaseStreamRetentionPeriod -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriod -> m DecreaseStreamRetentionPeriod # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriod -> m DecreaseStreamRetentionPeriod # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriod -> m DecreaseStreamRetentionPeriod #
Read DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS DecreaseStreamRetentionPeriod # readList :: ReadS [DecreaseStreamRetentionPeriod] # readPrec :: ReadPrec DecreaseStreamRetentionPeriod # readListPrec :: ReadPrec [DecreaseStreamRetentionPeriod] #
Show DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods showsPrec :: Int -> DecreaseStreamRetentionPeriod -> ShowS # show :: DecreaseStreamRetentionPeriod -> String # showList :: [DecreaseStreamRetentionPeriod] -> ShowS #
Generic DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Associated Types type Rep DecreaseStreamRetentionPeriod :: * -> * # Methods from :: DecreaseStreamRetentionPeriod -> Rep DecreaseStreamRetentionPeriod x # to :: Rep DecreaseStreamRetentionPeriod x -> DecreaseStreamRetentionPeriod #
Hashable DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods hashWithSalt :: Int -> DecreaseStreamRetentionPeriod -> Int # hash :: DecreaseStreamRetentionPeriod -> Int #
ToJSON DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods toJSON :: DecreaseStreamRetentionPeriod -> Value # toEncoding :: DecreaseStreamRetentionPeriod -> Encoding # toJSONList :: [DecreaseStreamRetentionPeriod] -> Value # toEncodingList :: [DecreaseStreamRetentionPeriod] -> Encoding #
AWSRequest DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Associated Types type Rs DecreaseStreamRetentionPeriod :: * # Methods request :: DecreaseStreamRetentionPeriod -> Request DecreaseStreamRetentionPeriod # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DecreaseStreamRetentionPeriod -> ClientResponse -> m (Response DecreaseStreamRetentionPeriod) #
ToHeaders DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods toHeaders :: DecreaseStreamRetentionPeriod -> [Header] #
ToPath DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods toPath :: DecreaseStreamRetentionPeriod -> ByteString #
ToQuery DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods toQuery :: DecreaseStreamRetentionPeriod -> QueryString #
NFData DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods rnf :: DecreaseStreamRetentionPeriod -> () #
type Rep DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod type Rep DecreaseStreamRetentionPeriod = D1 (MetaData "DecreaseStreamRetentionPeriod" "Network.AWS.Kinesis.DecreaseStreamRetentionPeriod" "amazonka-kinesis-1.6.0-4YDemIxP4OfE57cYVD0y1c" False) (C1 (MetaCons "DecreaseStreamRetentionPeriod'" PrefixI True) (S1 (MetaSel (Just "_dsrpStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dsrpRetentionPeriodHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)))
type Rs DecreaseStreamRetentionPeriod #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod type Rs DecreaseStreamRetentionPeriod = DecreaseStreamRetentionPeriodResponse

Request Lenses

dsrpStreamName :: Lens' DecreaseStreamRetentionPeriod Text #

The name of the stream to modify.

dsrpRetentionPeriodHours :: Lens' DecreaseStreamRetentionPeriod Natural #

The new retention period of the stream, in hours. Must be less than the current retention period.

Destructuring the Response

decreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse #

Creates a value of DecreaseStreamRetentionPeriodResponse with the minimum fields required to make a request.

data DecreaseStreamRetentionPeriodResponse #

See: decreaseStreamRetentionPeriodResponse smart constructor.

Instances

Eq DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods (==) :: DecreaseStreamRetentionPeriodResponse -> DecreaseStreamRetentionPeriodResponse -> Bool # (/=) :: DecreaseStreamRetentionPeriodResponse -> DecreaseStreamRetentionPeriodResponse -> Bool #
Data DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DecreaseStreamRetentionPeriodResponse -> c DecreaseStreamRetentionPeriodResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DecreaseStreamRetentionPeriodResponse # toConstr :: DecreaseStreamRetentionPeriodResponse -> Constr # dataTypeOf :: DecreaseStreamRetentionPeriodResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DecreaseStreamRetentionPeriodResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DecreaseStreamRetentionPeriodResponse) # gmapT :: (forall b. Data b => b -> b) -> DecreaseStreamRetentionPeriodResponse -> DecreaseStreamRetentionPeriodResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DecreaseStreamRetentionPeriodResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DecreaseStreamRetentionPeriodResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DecreaseStreamRetentionPeriodResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DecreaseStreamRetentionPeriodResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriodResponse -> m DecreaseStreamRetentionPeriodResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriodResponse -> m DecreaseStreamRetentionPeriodResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DecreaseStreamRetentionPeriodResponse -> m DecreaseStreamRetentionPeriodResponse #
Read DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods readsPrec :: Int -> ReadS DecreaseStreamRetentionPeriodResponse # readList :: ReadS [DecreaseStreamRetentionPeriodResponse] # readPrec :: ReadPrec DecreaseStreamRetentionPeriodResponse # readListPrec :: ReadPrec [DecreaseStreamRetentionPeriodResponse] #
Show DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods showsPrec :: Int -> DecreaseStreamRetentionPeriodResponse -> ShowS # show :: DecreaseStreamRetentionPeriodResponse -> String # showList :: [DecreaseStreamRetentionPeriodResponse] -> ShowS #
Generic DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Associated Types type Rep DecreaseStreamRetentionPeriodResponse :: * -> * # Methods from :: DecreaseStreamRetentionPeriodResponse -> Rep DecreaseStreamRetentionPeriodResponse x # to :: Rep DecreaseStreamRetentionPeriodResponse x -> DecreaseStreamRetentionPeriodResponse #
NFData DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod Methods rnf :: DecreaseStreamRetentionPeriodResponse -> () #
type Rep DecreaseStreamRetentionPeriodResponse #
Instance details Defined in Network.AWS.Kinesis.DecreaseStreamRetentionPeriod type Rep DecreaseStreamRetentionPeriodResponse = D1 (MetaData "DecreaseStreamRetentionPeriodResponse" "Network.AWS.Kinesis.DecreaseStreamRetentionPeriod" "amazonka-kinesis-1.6.0-4YDemIxP4OfE57cYVD0y1c" False) (C1 (MetaCons "DecreaseStreamRetentionPeriodResponse'" PrefixI False) (U1 :: * -> *))