Kinesis / Client / decrease_stream_retention_period

decrease_stream_retention_period#

Kinesis.Client.decrease_stream_retention_period(**kwargs)#

Decreases 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 minimum value of a stream’s retention period is 24 hours.

Note

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.decrease_stream_retention_period(
    StreamName='string',
    RetentionPeriodHours=123,
    StreamARN='string'
)
Parameters:

  • StreamName (string) – The name of the stream to modify.

  • RetentionPeriodHours (integer) –

    [REQUIRED]

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

  • StreamARN (string) – The ARN of the stream.

Returns:

None

Exceptions

  • Kinesis.Client.exceptions.ResourceInUseException

  • Kinesis.Client.exceptions.ResourceNotFoundException

  • Kinesis.Client.exceptions.LimitExceededException

  • Kinesis.Client.exceptions.InvalidArgumentException

  • Kinesis.Client.exceptions.AccessDeniedException