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

DescribeTable

Last update:
May 18, 2026

Description

This function returns the following information about a table:
  • Attributes
  • Date of creation
  • Global Secondary Indexes
  • Local Secondary Indexes
  • Schema
  • Provisioned Throughput
For more information, see DescribeTable.

Category

History

ColdFusion (2021 release): Added this function.

Syntax

serviceHandle.describeTable(requestParameters)

Parameters

See request parameters for DescribeTable.

Example

<cfscript> 
 cred = { 
    "credentialAlias" : "myalias", 
    "vendorName" : "AWS", 
    "region" : "us-east-2", 
    "secretAccessKey" : "xxxxx", 
    "accessKeyId" : "xxxx" 
  } 
  config = { 
    "serviceName" = "DYNAMODB" 
  } 
  dynamo = getCloudService(cred, config) 
  // list all tables 
  listTableStruct={ 
    "Limit":25 
  } 
  listTablesResponse=dynamo.listTables(listTableStruct) 
 
  // let's retrieve information about the table "YearlyProductCatalog" 
  if (ArrayContains(listTablesResponse.TableNames,"YearlyProductCatalog")){ 
    describeTableStruct={ 
      "TableName":"YearlyProductCatalog" 
    } 
    describeTableResponse=dynamo.describeTable(describeTableStruct) 
    writeDump(describeTableResponse) 
  } 
  else{ 
    writeOutput("Table not found") 
  } 
</cfscript>

Output

Figure: DescribeTable output
DescribeTable 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