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¶

METHODS /AWS1/IF_KNV~UPDATEDATARETENTION
  IMPORTING
    !IV_STREAMNAME TYPE /AWS1/KNVSTREAMNAME OPTIONAL
    !IV_STREAMARN TYPE /AWS1/KNVRESOURCEARN OPTIONAL
    !IV_CURRENTVERSION TYPE /AWS1/KNVVERSION OPTIONAL
    !IV_OPERATION TYPE /AWS1/KNVUPDATEDATARETOP OPTIONAL
    !IV_DATARETCHANGEINHOURS TYPE /AWS1/KNVDATARETCHANGEINHOURS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_knvupddataretoutput
  RAISING
    /AWS1/CX_KNVCLIENTLIMITEXCDEX
    /AWS1/CX_KNVINVALIDARGUMENTEX
    /AWS1/CX_KNVNOTAUTHORIZEDEX
    /AWS1/CX_KNVRESOURCEINUSEEX
    /AWS1/CX_KNVRESOURCENOTFOUNDEX
    /AWS1/CX_KNVVERSIONMISMATCHEX
    /AWS1/CX_KNVCLIENTEXC
    /AWS1/CX_KNVSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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 the ListStreams 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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_knvupddataretoutput` `/AWS1/CL_KNVUPDDATARETOUTPUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatedataretention(
  iv_currentversion = |string|
  iv_dataretchangeinhours = 123
  iv_operation = |string|
  iv_streamarn = |string|
  iv_streamname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_KNV=>UPDATEDATARETENTION()¶