AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisVideo.AmazonKinesisVideoRequest
      Amazon.KinesisVideo.Model.UpdateDataRetentionRequest

Namespace: Amazon.KinesisVideo.Model
Assembly: AWSSDK.KinesisVideo.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateDataRetentionRequest : AmazonKinesisVideoRequest
         IAmazonWebServiceRequest

The UpdateDataRetentionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property 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 DescribeStream or the ListStreams API.

Public Property DataRetentionChangeInHours System.Int32

Gets and sets the property DataRetentionChangeInHours.

The retention period, in hours. The value you specify replaces the current value.

Public Property Operation Amazon.KinesisVideo.UpdateDataRetentionOperation

Gets and sets the property Operation.

Indicates whether you want to increase or decrease the retention period.

Public Property StreamARN System.String

Gets and sets the property StreamARN.

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

Public Property StreamName System.String

Gets and sets the property StreamName.

The name of the stream whose retention period you want to change.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms