DescribeBackupJob - AWS Backup

DescribeBackupJob

Returns backup job details for the specified BackupJobId.

Request Syntax

GET /backup-jobs/backupJobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

backupJobId

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AccountId": "string", "BackupJobId": "string", "BackupOptions": { "string" : "string" }, "BackupSizeInBytes": number, "BackupType": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "ExpectedCompletionDate": number, "IamRoleArn": "string", "InitiationDate": number, "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountId

Returns the account ID that owns the backup job.

Type: String

Pattern: ^[0-9]{12}$

BackupJobId

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

Type: String

BackupOptions

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

Type: String to string map

Key Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Value Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

BackupSizeInBytes

The size, in bytes, of a backup.

Type: Long

BackupType

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.

Type: String

BackupVaultArn

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

Type: String

BackupVaultName

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 AWS Region where they are created.

Type: String

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

BytesTransferred

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

Type: Long

ChildJobsInState

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

Type: String to long map

Valid Keys: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

CompletionDate

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.

Type: Timestamp

CreatedBy

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.

Type: RecoveryPointCreator object

CreationDate

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.

Type: Timestamp

ExpectedCompletionDate

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.

Type: Timestamp

IamRoleArn

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

Type: String

InitiationDate

The date a backup job was initiated.

Type: Timestamp

IsParent

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

Type: Boolean

MessageCategory

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.

Type: String

NumberOfChildJobs

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

Type: Long

ParentJobId

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

Type: String

PercentDone

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

Type: String

RecoveryPointArn

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

Type: String

ResourceArn

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

Type: String

ResourceName

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

Type: String

ResourceType

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

Type: String

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

StartBy

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.

Type: Timestamp

State

The current state of a backup job.

Type: String

Valid Values: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

StatusMessage

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyFailureException

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

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: