AWS Backup
Developer Guide

ListBackupJobs

Returns metadata about your backup jobs.

Request Syntax

GET /backup-jobs/?backupVaultName=ByBackupVaultName&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

ByBackupVaultName

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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

ByCreatedAfter

Returns only backup jobs that were created after the specified date.

ByCreatedBefore

Returns only backup jobs that were created before the specified date.

ByResourceArn

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

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

ByState

Returns only backup jobs that are in the specified state.

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

MaxResults

The maximum number of items to be returned.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupJobs": [ { "BackupJobId": "string", "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "ExpectedCompletionDate": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string" } ], "NextToken": "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.

BackupJobs

An array of structures containing metadata about your backup jobs returned in JSON format.

Type: Array of BackupJob objects

NextToken

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Type: String

Errors

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

InvalidParameterValueException

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

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: