amazonka-kinesis-1.4.5: Amazon Kinesis SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.DecreaseStreamRetentionPeriod

Contents

Description

Decreases the Amazon Kinesis 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 #

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:

data DecreaseStreamRetentionPeriod #

Represents the input for DecreaseStreamRetentionPeriod .

See: decreaseStreamRetentionPeriod smart constructor.

Instances

Eq DecreaseStreamRetentionPeriod # 
Data 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 # 
Show DecreaseStreamRetentionPeriod # 
Generic DecreaseStreamRetentionPeriod # 
Hashable DecreaseStreamRetentionPeriod # 
ToJSON DecreaseStreamRetentionPeriod # 
NFData DecreaseStreamRetentionPeriod # 
AWSRequest DecreaseStreamRetentionPeriod # 
ToQuery DecreaseStreamRetentionPeriod # 
ToPath DecreaseStreamRetentionPeriod # 
ToHeaders DecreaseStreamRetentionPeriod # 
type Rep DecreaseStreamRetentionPeriod # 
type Rep DecreaseStreamRetentionPeriod = D1 (MetaData "DecreaseStreamRetentionPeriod" "Network.AWS.Kinesis.DecreaseStreamRetentionPeriod" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "DecreaseStreamRetentionPeriod'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dsrpStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dsrpRetentionPeriodHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))
type Rs DecreaseStreamRetentionPeriod # 

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 #

Instances

Eq DecreaseStreamRetentionPeriodResponse # 
Data DecreaseStreamRetentionPeriodResponse # 

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 # 
Show DecreaseStreamRetentionPeriodResponse # 
Generic DecreaseStreamRetentionPeriodResponse # 
NFData DecreaseStreamRetentionPeriodResponse # 
type Rep DecreaseStreamRetentionPeriodResponse # 
type Rep DecreaseStreamRetentionPeriodResponse = D1 (MetaData "DecreaseStreamRetentionPeriodResponse" "Network.AWS.Kinesis.DecreaseStreamRetentionPeriod" "amazonka-kinesis-1.4.5-KpiBxTdO1bb1AUtj9QHRfG" False) (C1 (MetaCons "DecreaseStreamRetentionPeriodResponse'" PrefixI False) U1)