Skip to content
AWS for Query.Farm

aws.rbin.get_rule

Example SQL Queries

SELECT * FROM
aws.rbin.get_rule
WHERE
"identifier" = 'VALUE';

Description

Gets information about a Recycle Bin retention rule.

Table Definition

Column NameColumn Data Type
identifier Required Input Column

The unique ID of the retention rule.

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
description

The retention rule description.

VARCHAR
lock_configuration

Information about the retention rule lock configuration.

STRUCT(
    "unlock_delay" STRUCT(
        "unlock_delay_value" BIGINT,
        "unlock_delay_unit" VARCHAR
    )
)
Show child fields
lock_configuration.unlock_delay

Information about the retention rule unlock delay.

Show child fields
lock_configuration.unlock_delay.unlock_delay_unit

The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.

lock_configuration.unlock_delay.unlock_delay_value

The unlock delay period, measured in the unit specified for UnlockDelayUnit.

lock_end_time

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

TIMESTAMP_S
lock_state

The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.

  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

VARCHAR
resource_tags

Information about the resource tags used to identify resources that are retained by the retention rule.

STRUCT(
    "resource_tag_key" VARCHAR,
    "resource_tag_value" VARCHAR
)[]
Show child fields
resource_tags[]
Show child fields
resource_tags[].resource_tag_key

The tag key.

resource_tags[].resource_tag_value

The tag value.

resource_type

The resource type retained by the retention rule.

VARCHAR
retention_period

Information about the retention period for which the retention rule is to retain resources.

STRUCT(
    "retention_period_value" BIGINT,
    "retention_period_unit" VARCHAR
)
Show child fields
retention_period.retention_period_unit

The unit of time in which the retention period is measured. Currently, only DAYS is supported.

retention_period.retention_period_value

The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

rule_arn

The Amazon Resource Name (ARN) of the retention rule.

VARCHAR
status

The state of the retention rule. Only retention rules that are in the available state retain resources.

VARCHAR