Skip to content
AWS for Query.Farm

aws.backup.describe_report_plan

Example SQL Queries

SELECT * FROM
aws.backup.describe_report_plan
WHERE
"report_plan_name" = 'VALUE';

Description

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Table Definition

Column NameColumn Data Type
report_plan_name Required Input Column

The unique name of a report plan.

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
report_plan

Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

STRUCT(
    "report_plan_arn" VARCHAR,
    "report_plan_name" VARCHAR,
    "report_plan_description" VARCHAR,
    "report_setting" STRUCT(
        "report_template" VARCHAR,
        "framework_arns" VARCHAR[],
        "number_of_frameworks" BIGINT,
        "accounts" VARCHAR[],
        "organization_units" VARCHAR[],
        "regions" VARCHAR[]
    ),
    "report_delivery_channel" STRUCT(
        "s3_bucket_name" VARCHAR,
        "s3_key_prefix" VARCHAR,
        "formats" VARCHAR[]
    ),
    "deployment_status" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "last_attempted_execution_time" TIMESTAMP_S,
    "last_successful_execution_time" TIMESTAMP_S
)
Show child fields
report_plan.creation_time

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

report_plan.deployment_status

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

report_plan.last_attempted_execution_time

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

report_plan.last_successful_execution_time

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

report_plan.report_delivery_channel

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Show child fields
report_plan.report_delivery_channel.formats[]
report_plan.report_delivery_channel.s3_bucket_name

The unique name of the S3 bucket that receives your reports.

report_plan.report_delivery_channel.s3_key_prefix

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

report_plan.report_plan_arn

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

report_plan.report_plan_description

An optional description of the report plan with a maximum 1,024 characters.

report_plan.report_plan_name

The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

report_plan.report_setting

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Show child fields
report_plan.report_setting.accounts[]
report_plan.report_setting.framework_arns[]
report_plan.report_setting.number_of_frameworks

The number of frameworks a report covers.

report_plan.report_setting.organization_units[]
report_plan.report_setting.regions[]
report_plan.report_setting.report_template

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT