ListBackupJobs
Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
Request Syntax
GET /backup-jobs/?accountId=ByAccountId
&backupVaultName=ByBackupVaultName
&completeAfter=ByCompleteAfter
&completeBefore=ByCompleteBefore
&createdAfter=ByCreatedAfter
&createdBefore=ByCreatedBefore
&maxResults=MaxResults
&nextToken=NextToken
&parentJobId=ByParentJobId
&resourceArn=ByResourceArn
&resourceType=ByResourceType
&state=ByState
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ByAccountId
-
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an AWS Organizations management account, passing
*
returns all jobs across the organization.Pattern:
^[0-9]{12}$
- 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\-\_]{2,50}$
- ByCompleteAfter
-
Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
- ByCompleteBefore
-
Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
- ByCreatedAfter
-
Returns only backup jobs that were created after the specified date.
- ByCreatedBefore
-
Returns only backup jobs that were created before the specified date.
- ByParentJobId
-
This is a filter to list child (nested) jobs based on parent job ID.
- ByResourceArn
-
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
- ByResourceType
-
Returns only backup jobs for the specified resources:
-
Aurora
for Amazon Aurora -
DocumentDB
for Amazon DocumentDB (with MongoDB compatibility) -
DynamoDB
for Amazon DynamoDB -
EBS
for Amazon Elastic Block Store -
EC2
for Amazon Elastic Compute Cloud -
EFS
for Amazon Elastic File System -
FSx
for Amazon FSx -
Neptune
for Amazon Neptune -
RDS
for Amazon Relational Database Service -
Storage Gateway
for AWS Storage Gateway -
S3
for Amazon S3 -
VirtualMachine
for virtual machines
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 | PARTIAL
- 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": [
{
"AccountId": "string",
"BackupJobId": "string",
"BackupOptions": {
"string" : "string"
},
"BackupSizeInBytes": number,
"BackupType": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"BytesTransferred": number,
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"IsParent": boolean,
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "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: