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.

Decreases the Amazon Kinesis 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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDecreaseStreamRetentionPeriod and EndDecreaseStreamRetentionPeriod. For Unity the operation does not take CancellationToken as a parameter, and instead takes AmazonServiceCallback<DecreaseStreamRetentionPeriodRequest, DecreaseStreamRetentionPeriodResponse> and AsyncOptions as additional parameters.

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

Syntax

C#
public abstract Task<DecreaseStreamRetentionPeriodResponse> DecreaseStreamRetentionPeriodAsync(
         String streamName,
         Int32 retentionPeriodHours,
         CancellationToken cancellationToken
)
Parameters
streamName
Type: System.String

The name of the stream to modify.

retentionPeriodHours
Type: System.Int32

The new retention period of the stream, in hours. Must be less than the current retention period.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the DecreaseStreamRetentionPeriod service method, as returned by Kinesis.

Exceptions

ExceptionCondition
InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
ResourceInUseException The resource is not available for this operation. For successful operation, the resource needs to be in the ACTIVE state.
ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.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

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also