Skip to content

UpdateDataRetentionInput

Source code in docs_src/capo_kinesis_video/types/update_data_retention_input.py 
17
18
19
20
21
22
23
24
25
26
27
class UpdateDataRetentionInput(TypedDict, closed=True):
    stream_name: NotRequired["capo_kinesis_video.types.stream_name.StreamName"]
    """<p>The name of the stream whose retention period you want to change.</p>"""
    stream_arn: NotRequired["capo_kinesis_video.types.resource_arn.ResourceARN"]
    """<p>The Amazon Resource Name (ARN) of the stream whose retention period you want to change.</p>"""
    current_version: "capo_kinesis_video.types.version.Version"
    """<p>The version of the stream whose retention period you want to change. To get the version, call either the <code>DescribeStream</code> or the <code>ListStreams</code> API.</p>"""
    operation: "capo_kinesis_video.types.update_data_retention_operation.UpdateDataRetentionOperation"
    """<p>Indicates whether you want to increase or decrease the retention period.</p>"""
    data_retention_change_in_hours: "capo_kinesis_video.types.data_retention_change_in_hours.DataRetentionChangeInHours"
    """<p>The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the <code>operation</code>.</p> <p>The minimum value for data retention is 0 and the maximum value is 87600 (ten years).</p>"""

current_version instance-attribute 

current_version: Version

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

data_retention_change_in_hours instance-attribute 

data_retention_change_in_hours: DataRetentionChangeInHours

The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation.

The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

operation instance-attribute 

operation: UpdateDataRetentionOperation

Indicates whether you want to increase or decrease the retention period.

stream_arn instance-attribute 

stream_arn: NotRequired[ResourceARN]

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

stream_name instance-attribute 

stream_name: NotRequired[StreamName]

The name of the stream whose retention period you want to change.