v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

Returns backup job details for the specified <code>BackupJobId</code>.

get/backup-jobs/{backupJobId}

Path parameters

backupJobIdstring required

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

Response

Success

AccountIdstring

Returns the account ID that owns the backup job.

BackupJobIdstring

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

BackupVaultNamestring

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. They consist of lowercase letters, numbers, and hyphens.

BackupVaultArnstring

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

RecoveryPointArnstring

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

ResourceArnstring

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

CreationDatestring date-time

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

CompletionDatestring date-time

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 <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

State'CREATED' | 'PENDING' | 'RUNNING' | 'ABORTING' | 'ABORTED' | 'COMPLETED' | 'FAILED' | 'EXPIRED' | 'PARTIAL'

The current state of a resource recovery point.

StatusMessagestring

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

PercentDonestring

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

BackupSizeInBytesinteger

The size, in bytes, of a backup.

IamRoleArnstring

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

ResourceTypestring

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.

BytesTransferredinteger

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

ExpectedCompletionDatestring date-time

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 <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

StartBystring date-time

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 <code>StartBy</code> time would be 8:00 PM on the date specified. The value of <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

BackupOptionsobject

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

BackupTypestring

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

ParentJobIdstring

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

IsParentboolean

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

NumberOfChildJobsinteger

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

ChildJobsInStateobject

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

ResourceNamestring

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