Kinesis / Client / increase_stream_retention_period

increase_stream_retention_period#

Kinesis.Client.increase_stream_retention_period(**kwargs)#

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).

Note

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

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.

See also: AWS API Documentation

Request Syntax

response = client.increase_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 more 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