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

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

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.

Creating a Request

data DecreaseStreamRetentionPeriod Source #

Represents the input for DecreaseStreamRetentionPeriod.

See: newDecreaseStreamRetentionPeriod smart constructor.

Constructors

DecreaseStreamRetentionPeriod'
Fields streamARN :: Maybe Text The ARN of the stream. streamName :: Maybe Text The name of the stream to modify. retentionPeriodHours :: Int The new retention period of the stream, in hours. Must be less than the current retention period.

Instances

Instances details

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

newDecreaseStreamRetentionPeriod Source #

Arguments

:: Int	`DecreaseStreamRetentionPeriod`
-> DecreaseStreamRetentionPeriod

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

DecreaseStreamRetentionPeriod, decreaseStreamRetentionPeriod_streamARN - The ARN of the stream.

DecreaseStreamRetentionPeriod, decreaseStreamRetentionPeriod_streamName - The name of the stream to modify.

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

Request Lenses

decreaseStreamRetentionPeriod_streamARN :: Lens' DecreaseStreamRetentionPeriod (Maybe Text) Source #

The ARN of the stream.

decreaseStreamRetentionPeriod_streamName :: Lens' DecreaseStreamRetentionPeriod (Maybe Text) Source #

The name of the stream to modify.

decreaseStreamRetentionPeriod_retentionPeriodHours :: Lens' DecreaseStreamRetentionPeriod Int Source #

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

Destructuring the Response

data DecreaseStreamRetentionPeriodResponse Source #

See: newDecreaseStreamRetentionPeriodResponse smart constructor.

Constructors

DecreaseStreamRetentionPeriodResponse'

Instances

Instances details

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

newDecreaseStreamRetentionPeriodResponse :: DecreaseStreamRetentionPeriodResponse Source #

Create a value of DecreaseStreamRetentionPeriodResponse with all optional fields omitted.

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