Container for the parameters to the UpdateDataRetention operation.
Increases or decreases the stream's data retention period by the value that you specify.
To indicate whether you want to increase or decrease the data retention period, specify
the Operation parameter in the request body. In the request, you must specify
either the StreamName or the StreamARN.
This operation requires permission for the KinesisVideo:UpdateDataRetention
action.
Changing the data retention period affects the data in the stream as follows:
-
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
-
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KinesisVideo.AmazonKinesisVideoRequest
Amazon.KinesisVideo.Model.UpdateDataRetentionRequest
Namespace: Amazon.KinesisVideo.Model
Assembly: AWSSDK.KinesisVideo.dll
Version: 3.x.y.z
Syntax
public class UpdateDataRetentionRequest : AmazonKinesisVideoRequest IAmazonWebServiceRequest
The UpdateDataRetentionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateDataRetentionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CurrentVersion | System.String |
Gets and sets the property CurrentVersion.
The version of the stream whose retention period you want to change. To get the version,
call either the |
|
|
DataRetentionChangeInHours | System.Int32 |
Gets and sets the property DataRetentionChangeInHours.
The number of hours to adjust the current retention by. The value you specify is added
to or subtracted from the current value, depending on the The minimum value for data retention is 0 and the maximum value is 87600 (ten years). |
|
|
Operation | Amazon.KinesisVideo.UpdateDataRetentionOperation |
Gets and sets the property Operation. Indicates whether you want to increase or decrease the retention period. |
|
|
StreamARN | System.String |
Gets and sets the property StreamARN. The Amazon Resource Name (ARN) of the stream whose retention period you want to change. |
|
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream whose retention period you want to change. |
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