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

DescribeBackup

Last update:
May 18, 2026

Description

This function displays details regarding the backup of a table.
For more information, see DescribeBackup.

Category

History

ColdFusion (2021 release): Added this function.

Syntax

serviceHandle.describeBackup(requestParameters)

Parameters

See request parameters of DescribeBackup.

Example

<cfscript> 
  cred = { 
    "credentialAlias" : "myalias", 
    "vendorName" : "AWS", 
    "region" : "us-east-2", 
    "secretAccessKey" : "xxxxx", 
    "accessKeyId" : "xxxx" 
  } 
 
  conf={ 
    "serviceName"="DYNAMODB" 
  } 
 
  dynamo=getCloudService(cred, conf) 
  tableName="YearlyProductCatalog" 
 
  // list all backups 
  listBackupsStruct={ 
    "BackupType": "ALL", 
    "Limit":20, 
    "TableName":"#tableName#" 
  } 
  backupList=dynamo.listBackups(listBackupsStruct) 
 
  // retrieve the first Backup ARN for which we shall see the details 
  getArn=backupList.BackupSummaries[1].BackupArn 
  describeBackupStruct={ 
    "BackupArn": "#getArn#" 
  } 
 
  // describe backup 
  describeBackupResponse=dynamo.describeBackup(describeBackupStruct) 
  writeDump(describeBackupResponse) 
</cfscript>

Output

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