Skip to main content

report_plans_list_only

Lists report_plans in a region or regions, for all properties use report_plans

Overview

Namereport_plans_list_only
TypeResource
DescriptionContains detailed information about a report plan in AWS Backup Audit Manager.
Idaws.backup.report_plans_list_only

Fields

NameDatatypeDescription
report_plan_namestringThe unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_descriptionstringAn optional description of the report plan with a maximum of 1,024 characters.
report_plan_tagsarrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
report_delivery_channelobjectA structure that 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.
report_settingobjectIdentifies the report template for the report. Reports are built using a report template.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all report_plans in a region.

SELECT
region,
report_plan_arn
FROM aws.backup.report_plans_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the report_plans_list_only resource, see report_plans