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.

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:


For .NET Core and PCL this operation is only available in asynchronous form. Please refer to UpdateDataRetentionAsync.

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


public abstract UpdateDataRetentionResponse UpdateDataRetention(
         UpdateDataRetentionRequest request
Type: Amazon.KinesisVideo.Model.UpdateDataRetentionRequest

Container for the necessary parameters to execute the UpdateDataRetention service method.

Return Value
The response from the UpdateDataRetention service method, as returned by KinesisVideo.


ClientLimitExceededException Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
InvalidArgumentException The value for this input parameter is invalid.
NotAuthorizedException The caller is not authorized to perform this operation.
ResourceInUseException The stream is currently not available for this operation.
ResourceNotFoundException Amazon Kinesis Video Streams can't find the stream that you specified.
VersionMismatchException The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

Version Information

.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

See Also