Skip to content

/AWS1/CL_DYN=>UPDATETIMETOLIVE()

About UpdateTimeToLive

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

Method Signature

IMPORTING

Required arguments:

iv_tablename TYPE /AWS1/DYNTABLEARN /AWS1/DYNTABLEARN

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

io_timetolivespecification TYPE REF TO /AWS1/CL_DYNTIMETOLIVESPEC /AWS1/CL_DYNTIMETOLIVESPEC

Represents the settings used to enable or disable Time to Live for the specified table.

RETURNING

oo_output TYPE REF TO /aws1/cl_dynupdtimetoliveout /AWS1/CL_DYNUPDTIMETOLIVEOUT

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->/aws1/if_dyn~updatetimetolive(
  io_timetolivespecification = new /aws1/cl_dyntimetolivespec(
    iv_attributename = |string|
    iv_enabled = ABAP_TRUE
  )
  iv_tablename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_timetolivespecification = lo_result->get_timetolivespecification( ).
  IF lo_timetolivespecification IS NOT INITIAL.
    lv_timetoliveenabled = lo_timetolivespecification->get_enabled( ).
    lv_timetoliveattributename = lo_timetolivespecification->get_attributename( ).
  ENDIF.
ENDIF.