Skip to content
AWS for Query.Farm

aws.backup.get_legal_hold

Example SQL Queries

SELECT * FROM
aws.backup.get_legal_hold
WHERE
"legal_hold_id" = 'VALUE';

Description

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

Table Definition

Column NameColumn Data Type
legal_hold_id Required Input Column

This is the returned ID associated with a specified legal hold.

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
cancel_description

String describing the reason for removing the legal hold.

VARCHAR
cancellation_date

Time in number when legal hold was cancelled.

TIMESTAMP_S
creation_date

Time in number format when legal hold was created.

TIMESTAMP_S
description

This is the returned string description of the legal hold.

VARCHAR
legal_hold_arn

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

VARCHAR
recovery_point_selection

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

STRUCT(
    "vault_names" VARCHAR[],
    "resource_identifiers" VARCHAR[],
    "date_range" STRUCT(
        "from_date" TIMESTAMP_S,
        "to_date" TIMESTAMP_S
    )
)
Show child fields
recovery_point_selection.date_range

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Show child fields
recovery_point_selection.date_range.from_date

This value is the beginning date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

recovery_point_selection.date_range.to_date

This value is the end date, inclusive.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

recovery_point_selection.resource_identifiers[]
recovery_point_selection.vault_names[]
retain_record_until

This is the date and time until which the legal hold record will be retained.

TIMESTAMP_S
status

This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.

VARCHAR
title

This is the string title of the legal hold.

VARCHAR