Skip to content
AWS for Query.Farm

aws.backup.describe_backup_job

Example SQL Queries

SELECT * FROM
aws.backup.describe_backup_job
WHERE
"backup_job_id" = 'VALUE';

Description

Returns backup job details for the specified BackupJobId.

Table Definition

Column NameColumn Data Type
backup_job_id Required Input Column

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

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

Returns the account ID that owns the backup job.

VARCHAR
backup_options

Represents the options specified as part of backup plan or on-demand backup job.

MAP(VARCHAR, VARCHAR)
backup_size_in_bytes

The size, in bytes, of a backup.

BIGINT
backup_type

Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

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
child_jobs_in_state

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

MAP(VARCHAR, BIGINT)
completion_date

The date and time that 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 that is 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 that 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 that 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; for example, arn:aws:iam::123456789012:role/S3Access.

VARCHAR
initiation_date

This is the date a backup job was initiated.

TIMESTAMP_S
is_parent

This returns the boolean value that a backup job is a parent (composite) job.

BOOLEAN
message_category

This is the job count for the specified message category.

Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

VARCHAR
number_of_child_jobs

This returns the number of child (nested) backup jobs.

BIGINT
parent_job_id

This returns the parent (composite) resource backup job ID.

VARCHAR
percent_done

Contains an estimated percentage that is 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 saved 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.

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