Skip to content
AWS for Query.Farm

aws.backup.list_copy_jobs

Example SQL Queries

SELECT * FROM
aws.backup.list_copy_jobs;

Description

Returns metadata about your copy jobs.

Table Definition

Column NameColumn Data Type
by_account_id Input Column

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

VARCHAR
by_complete_after Input Column

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

TIMESTAMP_S
by_complete_before Input Column

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

TIMESTAMP_S
by_created_after Input Column

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

TIMESTAMP_S
by_created_before Input Column

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

TIMESTAMP_S
by_destination_vault_arn Input Column

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

VARCHAR
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 for a list of accepted 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
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 copy 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 copy jobs that are in the specified state.

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 copy job.

VARCHAR
backup_size_in_bytes

The size, in bytes, of a copy job.

BIGINT
child_jobs_in_state

This returns the statistics of the included child (nested) copy jobs.

MAP(VARCHAR, BIGINT)
completion_date

The date and time a copy 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
composite_member_identifier

This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

VARCHAR
copy_job_id

Uniquely identifies a copy job.

VARCHAR
created_by

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

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 copy 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
destination_backup_vault_arn

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

VARCHAR
destination_recovery_point_arn

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

VARCHAR
iam_role_arn

Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

VARCHAR
is_parent

This is a boolean value indicating this is a parent (composite) copy 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
number_of_child_jobs

This is the number of child (nested) copy jobs.

BIGINT
parent_job_id

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

VARCHAR
resource_arn

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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 copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

VARCHAR
source_backup_vault_arn

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

VARCHAR
source_recovery_point_arn

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

VARCHAR
state

The current state of a copy job.

VARCHAR
status_message

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

VARCHAR