DescribeBackupJobCommand

Suggest an Edit

Returns backup job details for the specified BackupJobId.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BackupClient, DescribeBackupJobCommand } from "@aws-sdk/client-backup"; // ES Modules import
// const { BackupClient, DescribeBackupJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import
const client = new BackupClient(config);
const input = { // DescribeBackupJobInput
  BackupJobId: "STRING_VALUE", // required
};
const command = new DescribeBackupJobCommand(input);
const response = await client.send(command);
// { // DescribeBackupJobOutput
//   AccountId: "STRING_VALUE",
//   BackupJobId: "STRING_VALUE",
//   BackupVaultName: "STRING_VALUE",
//   BackupVaultArn: "STRING_VALUE",
//   RecoveryPointArn: "STRING_VALUE",
//   ResourceArn: "STRING_VALUE",
//   CreationDate: new Date("TIMESTAMP"),
//   CompletionDate: new Date("TIMESTAMP"),
//   State: "CREATED" || "PENDING" || "RUNNING" || "ABORTING" || "ABORTED" || "COMPLETED" || "FAILED" || "EXPIRED" || "PARTIAL",
//   StatusMessage: "STRING_VALUE",
//   PercentDone: "STRING_VALUE",
//   BackupSizeInBytes: Number("long"),
//   IamRoleArn: "STRING_VALUE",
//   CreatedBy: { // RecoveryPointCreator
//     BackupPlanId: "STRING_VALUE",
//     BackupPlanArn: "STRING_VALUE",
//     BackupPlanVersion: "STRING_VALUE",
//     BackupRuleId: "STRING_VALUE",
//   },
//   ResourceType: "STRING_VALUE",
//   BytesTransferred: Number("long"),
//   ExpectedCompletionDate: new Date("TIMESTAMP"),
//   StartBy: new Date("TIMESTAMP"),
//   BackupOptions: { // BackupOptions
//     "<keys>": "STRING_VALUE",
//   },
//   BackupType: "STRING_VALUE",
//   ParentJobId: "STRING_VALUE",
//   IsParent: true || false,
//   NumberOfChildJobs: Number("long"),
//   ChildJobsInState: { // BackupJobChildJobsInState
//     "<keys>": Number("long"),
//   },
//   ResourceName: "STRING_VALUE",
//   InitiationDate: new Date("TIMESTAMP"),
//   MessageCategory: "STRING_VALUE",
// };

DescribeBackupJobCommand Input

See DescribeBackupJobCommandInput for more details

Parameter
Type
Description
BackupJobId
Required
string | undefined

Uniquely identifies a request to Backup to back up a resource.

DescribeBackupJobCommand Output

See DescribeBackupJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AccountId
string | undefined

Returns the account ID that owns the backup job.

BackupJobId
string | undefined

Uniquely identifies a request to Backup to back up a resource.

BackupOptions
Record<string, string> | undefined

Represents the options specified as part of backup plan or on-demand backup job.

BackupSizeInBytes
number | undefined

The size, in bytes, of a backup.

BackupType
string | undefined

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

BackupVaultArn
string | undefined

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

BackupVaultName
string | undefined

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

BytesTransferred
number | undefined

The size in bytes transferred to a backup vault at the time that the job status was queried.

ChildJobsInState
Partial<Record<BackupJobState, number> | undefined

This returns the statistics of the included child (nested) backup jobs.

CompletionDate
Date | undefined

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

CreatedBy
RecoveryPointCreator | undefined

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

CreationDate
Date | undefined

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

ExpectedCompletionDate
Date | undefined

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

IamRoleArn
string | undefined

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

InitiationDate
Date | undefined

The date a backup job was initiated.

IsParent
boolean | undefined

This returns the boolean value that a backup job is a parent (composite) job.

MessageCategory
string | undefined

The job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring  for a list of accepted MessageCategory strings.

NumberOfChildJobs
number | undefined

This returns the number of child (nested) backup jobs.

ParentJobId
string | undefined

This returns the parent (composite) resource backup job ID.

PercentDone
string | undefined

Contains an estimated percentage that is complete of a job at the time the job status was queried.

RecoveryPointArn
string | undefined

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn
string | undefined

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

ResourceName
string | undefined

The non-unique name of the resource that belongs to the specified backup.

ResourceType
string | undefined

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

StartBy
Date | undefined

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State
BackupJobState | undefined

The current state of a backup job.

StatusMessage
string | undefined

A detailed message explaining the status of the job to back up a resource.

Throws

Name
Fault
Details
DependencyFailureException
server

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

InvalidParameterValueException
client

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

MissingParameterValueException
client

Indicates that a required parameter is missing.

ResourceNotFoundException
client

A resource that is required for the action doesn't exist.

ServiceUnavailableException
server

The request failed due to a temporary failure of the server.

BackupServiceException
Base exception class for all service exceptions from Backup service.