DescribeBackup

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)
serviceHandle.describeBackup(requestParameters)
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>
<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>
<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

DescribeBackup output
DescribeBackup output

Get help faster and easier

New user?