DescribeTable

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

DescribeTable output
DescribeTable output

 Adobe

Get help faster and easier

New user?

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online