Network.AWS.Kinesis.IncreaseStreamRetentionPeriod

Increases 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 maximum value of a stream's retention period is 168 hours (7 days).

Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.

Creating a Request

increaseStreamRetentionPeriod

Arguments

:: Text

isrpStreamName

-> Natural

isrpRetentionPeriodHours

-> IncreaseStreamRetentionPeriod

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

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

• isrpStreamName - The name of the stream to modify.
• isrpRetentionPeriodHours - The new retention period of the stream, in hours. Must be more than the current retention period.

data IncreaseStreamRetentionPeriod

Represents the input for IncreaseStreamRetentionPeriod .

See: increaseStreamRetentionPeriod smart constructor.

Instances

Eq IncreaseStreamRetentionPeriod

Methods

(==) :: IncreaseStreamRetentionPeriod -> IncreaseStreamRetentionPeriod -> Bool

(/=) :: IncreaseStreamRetentionPeriod -> IncreaseStreamRetentionPeriod -> Bool

Data IncreaseStreamRetentionPeriod

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IncreaseStreamRetentionPeriod -> c IncreaseStreamRetentionPeriod

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IncreaseStreamRetentionPeriod

toConstr :: IncreaseStreamRetentionPeriod -> Constr

dataTypeOf :: IncreaseStreamRetentionPeriod -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IncreaseStreamRetentionPeriod)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IncreaseStreamRetentionPeriod)

gmapT :: (forall b. Data b => b -> b) -> IncreaseStreamRetentionPeriod -> IncreaseStreamRetentionPeriod

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IncreaseStreamRetentionPeriod -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IncreaseStreamRetentionPeriod -> r

gmapQ :: (forall d. Data d => d -> u) -> IncreaseStreamRetentionPeriod -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IncreaseStreamRetentionPeriod -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriod -> m IncreaseStreamRetentionPeriod

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriod -> m IncreaseStreamRetentionPeriod

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriod -> m IncreaseStreamRetentionPeriod

Read IncreaseStreamRetentionPeriod

Methods

readsPrec :: Int -> ReadS IncreaseStreamRetentionPeriod

readList :: ReadS [IncreaseStreamRetentionPeriod]

readPrec :: ReadPrec IncreaseStreamRetentionPeriod

readListPrec :: ReadPrec [IncreaseStreamRetentionPeriod]

Show IncreaseStreamRetentionPeriod

Methods

showsPrec :: Int -> IncreaseStreamRetentionPeriod -> ShowS

show :: IncreaseStreamRetentionPeriod -> String

showList :: [IncreaseStreamRetentionPeriod] -> ShowS

Generic IncreaseStreamRetentionPeriod

Associated Types

type Rep IncreaseStreamRetentionPeriod :: * -> *

Methods

from :: IncreaseStreamRetentionPeriod -> Rep IncreaseStreamRetentionPeriod x

to :: Rep IncreaseStreamRetentionPeriod x -> IncreaseStreamRetentionPeriod

Hashable IncreaseStreamRetentionPeriod

Methods

hashWithSalt :: Int -> IncreaseStreamRetentionPeriod -> Int

hash :: IncreaseStreamRetentionPeriod -> Int

ToJSON IncreaseStreamRetentionPeriod

Methods

toJSON :: IncreaseStreamRetentionPeriod -> Value

toEncoding :: IncreaseStreamRetentionPeriod -> Encoding

toJSONList :: [IncreaseStreamRetentionPeriod] -> Value

toEncodingList :: [IncreaseStreamRetentionPeriod] -> Encoding

NFData IncreaseStreamRetentionPeriod

Methods

rnf :: IncreaseStreamRetentionPeriod -> ()

AWSRequest IncreaseStreamRetentionPeriod

Associated Types

type Rs IncreaseStreamRetentionPeriod :: *

Methods

request :: IncreaseStreamRetentionPeriod -> Request IncreaseStreamRetentionPeriod

response :: MonadResource m => Logger -> Service -> Proxy * IncreaseStreamRetentionPeriod -> ClientResponse -> m (Response IncreaseStreamRetentionPeriod)

ToQuery IncreaseStreamRetentionPeriod

Methods

toQuery :: IncreaseStreamRetentionPeriod -> QueryString

ToPath IncreaseStreamRetentionPeriod

Methods

toPath :: IncreaseStreamRetentionPeriod -> ByteString

ToHeaders IncreaseStreamRetentionPeriod

Methods

toHeaders :: IncreaseStreamRetentionPeriod -> [Header]

type Rep IncreaseStreamRetentionPeriod

type Rep IncreaseStreamRetentionPeriod = D1 (MetaData "IncreaseStreamRetentionPeriod" "Network.AWS.Kinesis.IncreaseStreamRetentionPeriod" "amazonka-kinesis-1.5.0-9sBOxcpdcTN2BghkYmkXAp" False) (C1 (MetaCons "IncreaseStreamRetentionPeriod'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_isrpStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_isrpRetentionPeriodHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

type Rs IncreaseStreamRetentionPeriod

type Rs IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriodResponse

Request Lenses

isrpStreamName :: Lens' IncreaseStreamRetentionPeriod Text

The name of the stream to modify.

isrpRetentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Natural

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

Destructuring the Response

increaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse

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

data IncreaseStreamRetentionPeriodResponse

See: increaseStreamRetentionPeriodResponse smart constructor.

Instances

Eq IncreaseStreamRetentionPeriodResponse

Methods

(==) :: IncreaseStreamRetentionPeriodResponse -> IncreaseStreamRetentionPeriodResponse -> Bool

(/=) :: IncreaseStreamRetentionPeriodResponse -> IncreaseStreamRetentionPeriodResponse -> Bool

Data IncreaseStreamRetentionPeriodResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IncreaseStreamRetentionPeriodResponse -> c IncreaseStreamRetentionPeriodResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IncreaseStreamRetentionPeriodResponse

toConstr :: IncreaseStreamRetentionPeriodResponse -> Constr

dataTypeOf :: IncreaseStreamRetentionPeriodResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IncreaseStreamRetentionPeriodResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IncreaseStreamRetentionPeriodResponse)

gmapT :: (forall b. Data b => b -> b) -> IncreaseStreamRetentionPeriodResponse -> IncreaseStreamRetentionPeriodResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IncreaseStreamRetentionPeriodResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IncreaseStreamRetentionPeriodResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> IncreaseStreamRetentionPeriodResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IncreaseStreamRetentionPeriodResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriodResponse -> m IncreaseStreamRetentionPeriodResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriodResponse -> m IncreaseStreamRetentionPeriodResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IncreaseStreamRetentionPeriodResponse -> m IncreaseStreamRetentionPeriodResponse

Read IncreaseStreamRetentionPeriodResponse

Methods

readsPrec :: Int -> ReadS IncreaseStreamRetentionPeriodResponse

readList :: ReadS [IncreaseStreamRetentionPeriodResponse]

readPrec :: ReadPrec IncreaseStreamRetentionPeriodResponse

readListPrec :: ReadPrec [IncreaseStreamRetentionPeriodResponse]

Show IncreaseStreamRetentionPeriodResponse

Methods

showsPrec :: Int -> IncreaseStreamRetentionPeriodResponse -> ShowS

show :: IncreaseStreamRetentionPeriodResponse -> String

showList :: [IncreaseStreamRetentionPeriodResponse] -> ShowS

Generic IncreaseStreamRetentionPeriodResponse

Associated Types

type Rep IncreaseStreamRetentionPeriodResponse :: * -> *

Methods

from :: IncreaseStreamRetentionPeriodResponse -> Rep IncreaseStreamRetentionPeriodResponse x

to :: Rep IncreaseStreamRetentionPeriodResponse x -> IncreaseStreamRetentionPeriodResponse

NFData IncreaseStreamRetentionPeriodResponse

Methods

rnf :: IncreaseStreamRetentionPeriodResponse -> ()

type Rep IncreaseStreamRetentionPeriodResponse

type Rep IncreaseStreamRetentionPeriodResponse = D1 (MetaData "IncreaseStreamRetentionPeriodResponse" "Network.AWS.Kinesis.IncreaseStreamRetentionPeriod" "amazonka-kinesis-1.5.0-9sBOxcpdcTN2BghkYmkXAp" False) (C1 (MetaCons "IncreaseStreamRetentionPeriodResponse'" PrefixI False) U1)