Whatever message this page gives is out now! Go check it out!

DescribeTimeToLive

Last update:
May 18, 2026

Description

This function returns the status of the Time to Live (TTL) of a specified table.
For more information, see DescribeTimeToLive.

Category

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>

Output

Figure: DescribeTimeToLive output
DescribeTimeToLive output

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page