| 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.IncreaseStreamRetentionPeriod
Description
Increases 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 maximum value of a stream's retention period is 8760 hours (365 days).
When invoking this API, it is recommended you use the StreamARN input
parameter rather than the StreamName input parameter.
If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (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 remains inaccessible to consumer applications.
Synopsis
- data IncreaseStreamRetentionPeriod = IncreaseStreamRetentionPeriod' {}
- newIncreaseStreamRetentionPeriod :: Int -> IncreaseStreamRetentionPeriod
- increaseStreamRetentionPeriod_streamARN :: Lens' IncreaseStreamRetentionPeriod (Maybe Text)
- increaseStreamRetentionPeriod_streamName :: Lens' IncreaseStreamRetentionPeriod (Maybe Text)
- increaseStreamRetentionPeriod_retentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Int
- data IncreaseStreamRetentionPeriodResponse = IncreaseStreamRetentionPeriodResponse' {
- newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse
Creating a Request
data IncreaseStreamRetentionPeriod Source #
Represents the input for IncreaseStreamRetentionPeriod.
See: newIncreaseStreamRetentionPeriod smart constructor.
Constructors
| IncreaseStreamRetentionPeriod' | |
Fields
| |
Instances
newIncreaseStreamRetentionPeriod Source #
Create a value of IncreaseStreamRetentionPeriod 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:
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_streamARN - The ARN of the stream.
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_streamName - The name of the stream to modify.
IncreaseStreamRetentionPeriod, increaseStreamRetentionPeriod_retentionPeriodHours - The new retention period of the stream, in hours. Must be more than the
current retention period.
Request Lenses
increaseStreamRetentionPeriod_streamARN :: Lens' IncreaseStreamRetentionPeriod (Maybe Text) Source #
The ARN of the stream.
increaseStreamRetentionPeriod_streamName :: Lens' IncreaseStreamRetentionPeriod (Maybe Text) Source #
The name of the stream to modify.
increaseStreamRetentionPeriod_retentionPeriodHours :: Lens' IncreaseStreamRetentionPeriod Int Source #
The new retention period of the stream, in hours. Must be more than the current retention period.
Destructuring the Response
data IncreaseStreamRetentionPeriodResponse Source #
See: newIncreaseStreamRetentionPeriodResponse smart constructor.
Constructors
| IncreaseStreamRetentionPeriodResponse' | |
Instances
newIncreaseStreamRetentionPeriodResponse :: IncreaseStreamRetentionPeriodResponse Source #
Create a value of IncreaseStreamRetentionPeriodResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.