list-backup-jobs¶

Description¶

Returns a list of existing backup jobs for an authenticated account.

Synopsis¶

  list-backup-jobs
[--next-token <value>]
[--max-results <value>]
[--by-resource-arn <value>]
[--by-state <value>]
[--by-backup-vault-name <value>]
[--by-created-before <value>]
[--by-created-after <value>]
[--by-resource-type <value>]
[--by-account-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--next-token (string)

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.

--max-results (integer)

The maximum number of items to be returned.

--by-resource-arn (string)

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

--by-state (string)

Returns only backup jobs that are in the specified state.

Possible values:

CREATED

PENDING

RUNNING

ABORTING

ABORTED

COMPLETED

FAILED

EXPIRED

--by-backup-vault-name (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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

--by-created-before (timestamp)

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

--by-created-after (timestamp)

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

--by-resource-type (string)

Returns only backup jobs for the specified resources:

DynamoDB for Amazon DynamoDB

EBS for Amazon Elastic Block Store

EC2 for Amazon Elastic Compute Cloud

EFS for Amazon Elastic File System

RDS for Amazon Relational Database Service

Aurora for Amazon Aurora

Storage Gateway for AWS Storage Gateway

--by-account-id (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Example 1: To list all backup jobs

The following list-backup-jobs example returns metadata about your backup jobs in your AWS account.

aws backup list-backup-jobs

Output:

{
    "BackupJobs": [
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-12345678901234567",
            "CreationDate": 1600721892.929,
            "State": "CREATED",
            "PercentDone": "0.0",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725492.929,
            "ResourceType": "EC2"
        },
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678",
            "CreationDate": 1600721724.77,
            "CompletionDate": 1600721744.488,
            "State": "COMPLETED",
            "PercentDone": "100.0",
            "BackupSizeInBytes": 71,
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725324.77,
            "ResourceType": "EFS"
        }
    ]
}

For more information, see Creating a Backup in the AWS Backup Developer Guide.

Example 2: To list completed backup jobs

The following list-backup-jobs example returns metadata about your completed backup jobs in your AWS account.

aws backup list-backup-jobs \
    --by-state COMPLETED

Output:

{
    "BackupJobs": [
        {
            "BackupJobId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "BackupVaultName": "Default",
            "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:Default",
            "RecoveryPointArn": "arn:aws:backup:us-west-2:123456789012:recovery-point:a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "ResourceArn": "arn:aws:elasticfilesystem:us-west-2:123456789012:file-system/fs-12345678",
            "CreationDate": 1600721724.77,
            "CompletionDate": 1600721744.488,
            "State": "COMPLETED",
            "PercentDone": "100.0",
            "BackupSizeInBytes": 71,
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/AWSBackupDefaultServiceRole",
            "StartBy": 1600725324.77,
            "ResourceType": "EFS"
        }
    ]
}

For more information, see Creating a Backup in the AWS Backup Developer Guide.

Output¶

BackupJobs -> (list)

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

(structure)

Contains detailed information about a backup job.

AccountId -> (string)

The account ID that owns the backup job.

BackupJobId -> (string)

Uniquely identifies a request to AWS 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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

BackupVaultArn -> (string)

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012: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 -> (timestamp)

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 -> (timestamp)

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 resource recovery point.

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 -> (long)

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 -> (structure)

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 -> (timestamp)

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 -> (timestamp)

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 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. For VSS Windows backups, the only supported resource type is Amazon EC2.

BytesTransferred -> (long)

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

BackupOptions -> (map)

Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

key -> (string)

value -> (string)

BackupType -> (string)

Represents the type of backup for a backup job.

NextToken -> (string)