DescribeBackupJob
In this article:
DescribeBackupJob#
Description#
Request for the data on a backup job.
Request Parameters#
BackupJobId — The backup job ID.
Type: String
Required: Yes
Response Elements#
AccountId — Project in which the backup job is created.
Type: String
BackupJobId — The backup job ID.
Type: String
BackupVaultArn — The Amazon Resource Name (ARN) of the backup vault.
Type: String
BackupVaultName — The name of the backup vault.
Type: String
CompletionDate — The time when the job was completed.
Type: Timestamp
CreatedBy — Information on the backup plan and rules used to initiate the recovery point creation process.
Type: RecoveryPointCreator object
CreationDate — The time when the job was created.
Type: Timestamp
PercentDone — The percentage of task completion.
Type: Double
RecoveryPointArn — The Amazon Resource Name (ARN) of a recovery point.
Type: String
ResourceArn — The Amazon Resource Name (ARN) of the protected resource.
Type: String
ResourceType — The type of the protected resource.
Type: String
Valid values:
EC2
State — The state of the backup job.
Type: String
Valid values:
CREATED
|EXPIRED
|RUNNING
|COMPLETED
|FAILED
StatusMessage — A description of the reason for the current state of the backup job.
Type: String
Examples#
c2-bs DescribeBackupJob BackupJobId 0000-0000-0000