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.
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.
For .NET Core 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 )
Container for the necessary parameters to execute the UpdateDataRetention service method.
| Exception | Condition |
|---|---|
| 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 | When the input StreamARN or ChannelARN in CLOUD_STORAGE_MODE is already mapped to a different Kinesis Video Stream resource, or if the provided input StreamARN or ChannelARN is not in Active status, try one of the following : The DescribeMediaStorageConfiguration API to determine what the stream given channel is mapped to. The DescribeMappedResourceConfiguration API to determine the channel that the given stream is mapped to. The DescribeStream or DescribeSignalingChannel API to determine the status of the resource. |
| 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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5