/AWS1/CL_KNV=>UPDATEDATARETENTION()
¶
About UpdateDataRetention¶
Increases or decreases the stream's data retention period by the value that you
specify. To indicate whether you want to increase or decrease the data retention period,
specify the Operation
parameter in the request body. In the request, you
must specify either the StreamName
or the StreamARN
.
This operation requires permission for the
KinesisVideo:UpdateDataRetention
action.
Changing the data retention period affects the data in the stream as follows:
-
If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
-
If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CURRENTVERSION
TYPE /AWS1/KNVVERSION
/AWS1/KNVVERSION
¶
The version of the stream whose retention period you want to change. To get the version, call either the
DescribeStream
or theListStreams
API.
IV_OPERATION
TYPE /AWS1/KNVUPDATEDATARETOP
/AWS1/KNVUPDATEDATARETOP
¶
Indicates whether you want to increase or decrease the retention period.
IV_DATARETCHANGEINHOURS
TYPE /AWS1/KNVDATARETCHANGEINHOURS
/AWS1/KNVDATARETCHANGEINHOURS
¶
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).
Optional arguments:¶
IV_STREAMNAME
TYPE /AWS1/KNVSTREAMNAME
/AWS1/KNVSTREAMNAME
¶
The name of the stream whose retention period you want to change.
IV_STREAMARN
TYPE /AWS1/KNVRESOURCEARN
/AWS1/KNVRESOURCEARN
¶
The Amazon Resource Name (ARN) of the stream whose retention period you want to change.