Backup / Paginator / ListBackupJobs

ListBackupJobs#

class Backup.Paginator.ListBackupJobs#

paginator = client.get_paginator('list_backup_jobs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Backup.Client.list_backup_jobs().

Request Syntax

response_iterator = paginator.paginate(
    ByResourceArn='string',
    ByState='CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
    ByBackupVaultName='string',
    ByCreatedBefore=datetime(2015, 1, 1),
    ByCreatedAfter=datetime(2015, 1, 1),
    ByResourceType='string',
    ByAccountId='string',
    ByCompleteAfter=datetime(2015, 1, 1),
    ByCompleteBefore=datetime(2015, 1, 1),
    ByParentJobId='string',
    ByMessageCategory='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ByResourceArn (string) – Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
ByState (string) –
Returns only backup jobs that are in the specified state.

Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message.

To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED
ByBackupVaultName (string) – 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 Amazon Web Services Region where they are created.
ByCreatedBefore (datetime) – Returns only backup jobs that were created before the specified date.
ByCreatedAfter (datetime) – Returns only backup jobs that were created after the specified date.
ByResourceType (string) –
Returns only backup jobs for the specified resources:
- Aurora for Amazon Aurora
- CloudFormation for CloudFormation
- 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
- Redshift for Amazon Redshift
- S3 for Amazon Simple Storage Service (Amazon S3)
- SAP HANA on Amazon EC2 for SAP HANA databases on Amazon Elastic Compute Cloud instances
- Storage Gateway for Storage Gateway
- Timestream for Amazon Timestream
- VirtualMachine for VMware virtual machines
ByAccountId (string) –
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.
ByCompleteAfter (datetime) – Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ByCompleteBefore (datetime) – Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ByParentJobId (string) – This is a filter to list child (nested) jobs based on parent job ID.
ByMessageCategory (string) –
This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.

View Monitoring

The wildcard () returns count of all message categories.

AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'BackupJobs': [
        {
            'AccountId': 'string',
            'BackupJobId': 'string',
            'BackupVaultName': 'string',
            'BackupVaultArn': 'string',
            'RecoveryPointArn': 'string',
            'ResourceArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'CompletionDate': datetime(2015, 1, 1),
            'State': 'CREATED'|'PENDING'|'RUNNING'|'ABORTING'|'ABORTED'|'COMPLETED'|'FAILED'|'EXPIRED'|'PARTIAL',
            'StatusMessage': 'string',
            'PercentDone': 'string',
            'BackupSizeInBytes': 123,
            'IamRoleArn': 'string',
            'CreatedBy': {
                'BackupPlanId': 'string',
                'BackupPlanArn': 'string',
                'BackupPlanVersion': 'string',
                'BackupRuleId': 'string'
            },
            'ExpectedCompletionDate': datetime(2015, 1, 1),
            'StartBy': datetime(2015, 1, 1),
            'ResourceType': 'string',
            'BytesTransferred': 123,
            'BackupOptions': {
                'string': 'string'
            },
            'BackupType': 'string',
            'ParentJobId': 'string',
            'IsParent': True|False,
            'ResourceName': 'string',
            'InitiationDate': datetime(2015, 1, 1),
            'MessageCategory': 'string'
        },
    ],

}

Response Structure

(dict) –
- BackupJobs (list) –
  
  An array of structures containing metadata about your backup jobs returned in JSON format.
  - (dict) –
    
    Contains detailed information about a backup job.
    - AccountId (string) –
      
      The account ID that owns the backup job.
    - BackupJobId (string) –
      
      Uniquely identifies a request to Backup to back up a resource.
    - BackupVaultName (string) –
      
      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.
    - BackupVaultArn (string) –
      
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
    - RecoveryPointArn (string) –
      
      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) –
      
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - CreationDate (datetime) –
      
      The date and time 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.
    - CompletionDate (datetime) –
      
      The date and time 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.
    - State (string) –
      
      The current state of a backup job.
    - StatusMessage (string) –
      
      A detailed message explaining the status of the job to back up a resource.
    - PercentDone (string) –
      
      Contains an estimated percentage complete of a job at the time the job status was queried.
    - BackupSizeInBytes (integer) –
      
      The size, in bytes, of a backup.
    - IamRoleArn (string) –
      
      Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
    - CreatedBy (dict) –
      
      Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
      - BackupPlanId (string) –
        
        Uniquely identifies a backup plan.
      - BackupPlanArn (string) –
        
        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
      - BackupPlanVersion (string) –
        
        Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
      - BackupRuleId (string) –
        
        Uniquely identifies a rule used to schedule the backup of a selection of resources.
    - ExpectedCompletionDate (datetime) –
      
      The date and time 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.
    - StartBy (datetime) –
      
      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.
    - ResourceType (string) –
      
      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. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    - BytesTransferred (integer) –
      
      The size in bytes transferred to a backup vault at the time that the job status was queried.
    - BackupOptions (dict) –
      
      Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
      
      Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
      - (string) –
        
        (string) –
    - BackupType (string) –
      
      Represents the type of backup for a backup job.
    - ParentJobId (string) –
      
      This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
    - IsParent (boolean) –
      
      This is a boolean value indicating this is a parent (composite) backup job.
    - ResourceName (string) –
      
      The non-unique name of the resource that belongs to the specified backup.
    - InitiationDate (datetime) –
      
      The date on which the backup job was initiated.
    - MessageCategory (string) –
      
      This parameter is the job count for the specified message category.
      
      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
      
      The the value ANY returns count of all message categories.
      
      AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.