Skip to content
AWS for Query.Farm

aws.backup.list_backup_jobs

Example SQL Queries

SELECT * FROM
aws.backup.list_backup_jobs;

Description

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.

Table Definition

Column NameColumn Data Type
by_account_id Input Column

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.

VARCHAR
by_backup_vault_name Input Column

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. They consist of lowercase letters, numbers, and hyphens.

VARCHAR
by_complete_after Input Column

Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

TIMESTAMP_S
by_complete_before Input Column

Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

TIMESTAMP_S
by_created_after Input Column

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

TIMESTAMP_S
by_created_before Input Column

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

TIMESTAMP_S
by_message_category Input Column

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.

VARCHAR
by_parent_job_id Input Column

This is a filter to list child (nested) jobs based on parent job ID.

VARCHAR
by_resource_arn Input Column

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

VARCHAR
by_resource_type Input Column

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

  • Redshift for Amazon Redshift

  • RDS for Amazon Relational Database Service

  • SAP HANA on Amazon EC2 for SAP HANA databases

  • Storage Gateway for Storage Gateway

  • S3 for Amazon S3

  • Timestream for Amazon Timestream

  • VirtualMachine for virtual machines

VARCHAR
by_state Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
account_id

The account ID that owns the backup job.

VARCHAR
backup_job_id

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

VARCHAR
backup_options

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.

MAP(VARCHAR, VARCHAR)
backup_size_in_bytes

The size, in bytes, of a backup.

BIGINT
backup_type

Represents the type of backup for a backup job.

VARCHAR
backup_vault_arn

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

VARCHAR
backup_vault_name

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. They consist of lowercase letters, numbers, and hyphens.

VARCHAR
bytes_transferred

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

BIGINT
completion_date

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.

TIMESTAMP_S
created_by

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.

STRUCT(
    "backup_plan_id" VARCHAR,
    "backup_plan_arn" VARCHAR,
    "backup_plan_version" VARCHAR,
    "backup_rule_id" VARCHAR
)
Show child fields
created_by.backup_plan_arn

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.

created_by.backup_plan_id

Uniquely identifies a backup plan.

created_by.backup_plan_version

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

created_by.backup_rule_id

Uniquely identifies a rule used to schedule the backup of a selection of resources.

creation_date

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.

TIMESTAMP_S
expected_completion_date

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.

TIMESTAMP_S
iam_role_arn

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.

VARCHAR
initiation_date

This is the date on which the backup job was initiated.

TIMESTAMP_S
is_parent

This is a boolean value indicating this is a parent (composite) backup job.

BOOLEAN
message_category

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.

VARCHAR
parent_job_id

This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.

VARCHAR
percent_done

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

VARCHAR
recovery_point_arn

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

VARCHAR
resource_arn

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

VARCHAR
resource_name

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

VARCHAR
resource_type

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.

VARCHAR
start_by

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.

TIMESTAMP_S
state

The current state of a backup job.

VARCHAR
status_message

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

VARCHAR