DescribeTimeToLive

Last updated on 27 Des 2022

Description

This function returns the status of the Time to Live (TTL) of a specified table.

For more information, see DescribeTimeToLive.

History

ColdFusion (2021 release): Added this function.

Syntax

serviceHandle.describeTimeToLive(requestParameters)

Parameters

See request parameters for DescribeTimeToLive.

Example

<cfscript> 
  cred = { 
    "credentialAlias" : "myalias", 
    "vendorName" : "AWS", 
    "region" : "us-east-2", 
    "secretAccessKey" : "xxxxx", 
    "accessKeyId" : "xxxx" 
  } 
  config = { 
    "serviceName" = "DYNAMODB" 
  } 
  dynamo = getCloudService(cred, config) 
 
  tableName="YearlyProductCatalog" 
  describeTTLStruct={ 
    "TableName":"#tableName#" 
  } 
  describeTTLResponse=dynamo.describeTimeToLive(describeTTLStruct) 
  writeDump(describeTTLResponse) 
</cfscript>