Skip to content

increase_stream_retention_period

Operation

increase_stream_retention_period

increase_stream_retention_period(request: IncreaseStreamRetentionPeriodInput | IncreaseStreamRetentionPeriodInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[IncreaseStreamRetentionPeriodInputDict]) -> IncreaseStreamRetentionPeriodOutput

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

Parameters:

Name Type Description Default
request IncreaseStreamRetentionPeriodInput | IncreaseStreamRetentionPeriodInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[IncreaseStreamRetentionPeriodInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
IncreaseStreamRetentionPeriodOutput

An instance of IncreaseStreamRetentionPeriodOutput.

increase_stream_retention_period async

increase_stream_retention_period(request: IncreaseStreamRetentionPeriodInput | IncreaseStreamRetentionPeriodInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[IncreaseStreamRetentionPeriodInputDict]) -> IncreaseStreamRetentionPeriodOutput

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

Parameters:

Name Type Description Default
request IncreaseStreamRetentionPeriodInput | IncreaseStreamRetentionPeriodInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[IncreaseStreamRetentionPeriodInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
IncreaseStreamRetentionPeriodOutput

An instance of IncreaseStreamRetentionPeriodOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

IncreaseStreamRetentionPeriodInputDict

Bases: TypedDict

Dictionary form of IncreaseStreamRetentionPeriodInput.

Attributes

retention_period_hours instance-attribute
retention_period_hours: Required[int]

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

stream_arn instance-attribute
stream_arn: str | None

The ARN of the stream.

stream_id instance-attribute
stream_id: str | None

Not Implemented. Reserved for future use.

stream_name instance-attribute
stream_name: str | None

The name of the stream to modify.

IncreaseStreamRetentionPeriodInput dataclass

Bases: _SerdeShape

Represents the input for IncreaseStreamRetentionPeriod.

Attributes

retention_period_hours class-attribute instance-attribute
retention_period_hours: int | None = ...

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

stream_arn class-attribute instance-attribute
stream_arn: str | None = ...

The ARN of the stream.

stream_id class-attribute instance-attribute
stream_id: str | None = ...

Not Implemented. Reserved for future use.

stream_name class-attribute instance-attribute
stream_name: str | None = ...

The name of the stream to modify.

Output

IncreaseStreamRetentionPeriodOutput dataclass

Bases: _SerdeShape

Dataclass for IncreaseStreamRetentionPeriodOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.