Skip to content
AWS for Query.Farm

aws.backup.list_recovery_points_by_backup_vault

Example SQL Queries

SELECT * FROM
aws.backup.list_recovery_points_by_backup_vault
WHERE
"backup_vault_name" = 'VALUE';

Description

Returns detailed information about the recovery points stored in a backup vault.

Table Definition

Column NameColumn Data Type
backup_vault_name Required Input Column

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
backup_vault_account_id Input Column

This parameter will sort the list of recovery points by account ID.

VARCHAR
by_backup_plan_id Input Column

Returns only recovery points that match the specified backup plan ID.

VARCHAR
by_created_after Input Column

Returns only recovery points that were created after the specified timestamp.

TIMESTAMP_S
by_created_before Input Column

Returns only recovery points that were created before the specified timestamp.

TIMESTAMP_S
by_parent_recovery_point_arn Input Column

This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).

VARCHAR
by_resource_arn Input Column

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

VARCHAR
by_resource_type Input Column

Returns only recovery points that match the specified resource type(s):

  • 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
_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
backup_size_in_bytes

The size, in bytes, of a backup.

BIGINT
backup_vault_arn

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

VARCHAR
calculated_lifecycle

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

STRUCT(
    "move_to_cold_storage_at" TIMESTAMP_S,
    "delete_at" TIMESTAMP_S
)
Show child fields
calculated_lifecycle.delete_at

A timestamp that specifies when to delete a recovery point.

calculated_lifecycle.move_to_cold_storage_at

A timestamp that specifies when to transition a recovery point to cold storage.

completion_date

The date and time a job to restore a recovery point 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
created_by

Contains identifying information about the creation of a recovery point, 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 a recovery point 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
encryption_key_arn

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

VARCHAR
iam_role_arn

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

VARCHAR
is_encrypted

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

BOOLEAN
is_parent

This is a boolean value indicating this is a parent (composite) recovery point.

BOOLEAN
last_restore_time

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

TIMESTAMP_S
lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.

STRUCT(
    "move_to_cold_storage_after_days" BIGINT,
    "delete_after_days" BIGINT,
    "opt_in_to_archive_for_supported_resources" BOOLEAN
)
Show child fields
lifecycle.delete_after_days

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

lifecycle.move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

lifecycle.opt_in_to_archive_for_supported_resources

Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

parent_recovery_point_arn

This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.

VARCHAR
recovery_point_arn

An Amazon Resource Name (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 saved as a recovery point; 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
source_backup_vault_arn

The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

VARCHAR
status

A status code specifying the state of the recovery point.

VARCHAR
status_message

A message explaining the reason of the recovery point deletion failure.

VARCHAR
vault_type

This is the type of vault in which the described recovery point is stored.

VARCHAR