Container for the parameters to the DecreaseStreamRetentionPeriod operation.
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, you must use either the StreamARN or the StreamName
parameter, or both. It is recommended that you use the StreamARN input parameter
when you invoke this API.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Kinesis.AmazonKinesisRequest
Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodRequest
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
Syntax
public class DecreaseStreamRetentionPeriodRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The DecreaseStreamRetentionPeriodRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DecreaseStreamRetentionPeriodRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
RetentionPeriodHours | System.Int32 |
Gets and sets the property RetentionPeriodHours. The new retention period of the stream, in hours. Must be less than the current retention period. |
|
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream to modify. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5