Skip to content
AWS for Query.Farm

aws.backup.describe_framework

Example SQL Queries

SELECT * FROM
aws.backup.describe_framework
WHERE
"framework_name" = 'VALUE';

Description

Returns the framework details for the specified FrameworkName.

Table Definition

Column NameColumn Data Type
framework_name Required Input Column

The unique name of a framework.

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
creation_time

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

TIMESTAMP_S
deployment_status

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED 

VARCHAR
framework_arn

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

VARCHAR
framework_controls

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

STRUCT(
    "control_name" VARCHAR,
    "control_input_parameters" STRUCT(
        "parameter_name" VARCHAR,
        "parameter_value" VARCHAR
    )[],
    "control_scope" STRUCT(
        "compliance_resource_ids" VARCHAR[],
        "compliance_resource_types" VARCHAR[],
        "tags" MAP(VARCHAR, VARCHAR)
    )
)[]
Show child fields
framework_controls[]
Show child fields
framework_controls[].control_input_parameters[]
Show child fields
framework_controls[].control_input_parameters[].parameter_name

The name of a parameter, for example, BackupPlanFrequency.

framework_controls[].control_input_parameters[].parameter_value

The value of parameter, for example, hourly.

framework_controls[].control_name

The name of a control. This name is between 1 and 256 characters.

framework_controls[].control_scope

The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see ControlScope.

Show child fields
framework_controls[].control_scope.compliance_resource_ids[]
framework_controls[].control_scope.compliance_resource_types[]
framework_controls[].control_scope.tags

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].

framework_description

An optional description of the framework.

VARCHAR
framework_status

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.

  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

  • INACTIVE when recording is turned off for all resources governed by the framework.

  • UNAVAILABLE when Backup is unable to validate recording status at this time.

VARCHAR
idempotency_token

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

VARCHAR