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 the Kinesis data stream's retention period, which is the length of time
data records are accessible after they are added to the stream. The maximum value
of a stream's retention period is 8760 hours (365 days).
When invoking this API, you must use either the StreamARN
or the StreamName
parameter, or both. It is recommended that you use the StreamARN
input parameter
when you invoke this API.
If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.
For .NET Core this operation is only available in asynchronous form. Please refer to IncreaseStreamRetentionPeriodAsync.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public virtual IncreaseStreamRetentionPeriodResponse IncreaseStreamRetentionPeriod( IncreaseStreamRetentionPeriodRequest request )
Container for the necessary parameters to execute the IncreaseStreamRetentionPeriod service method.
Exception | Condition |
---|---|
AccessDeniedException | Specifies that you do not have the permissions required to perform this operation. |
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. |
ResourceInUseException | The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state. |
ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5