AWS SDK Version 2 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.

.NET Framework 3.5
 
Decreases the 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.

Namespace: Amazon.Kinesis
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract DecreaseStreamRetentionPeriodResponse DecreaseStreamRetentionPeriod(
         String streamName,
         Int32 retentionPeriodHours
)

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.

Return Value
Type: Amazon.Kinesis.Model.DecreaseStreamRetentionPeriodResponse
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.
LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).
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, or it might not be in the ACTIVE state if the operation requires it.

Version Information

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