Skip to content

ReportSetting

Used by
Source code in docs_src/capo_backup/types/report_setting.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ReportSetting(TypedDict, closed=True):
    report_template: "capo_backup.types.string.string"
    """<p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p> <p> <code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT</code> </p>"""
    framework_arns: NotRequired["capo_backup.types.string_list.stringList"]
    """<p>The Amazon Resource Names (ARNs) of the frameworks a report covers.</p>"""
    number_of_frameworks: "capo_backup.types.integer.integer"
    """<p>The number of frameworks a report covers.</p>"""
    accounts: NotRequired["capo_backup.types.string_list.stringList"]
    """<p>These are the accounts to be included in the report.</p> <p>Use string value of <code>ROOT</code> to include all organizational units.</p>"""
    organization_units: NotRequired["capo_backup.types.string_list.stringList"]
    """<p>These are the Organizational Units to be included in the report.</p>"""
    regions: NotRequired["capo_backup.types.string_list.stringList"]
    """<p>These are the Regions to be included in the report.</p> <p>Use the wildcard as the string value to include all Regions.</p>"""

accounts instance-attribute 

accounts: NotRequired[stringList]

These are the accounts to be included in the report.

Use string value of ROOT to include all organizational units.

framework_arns instance-attribute 

framework_arns: NotRequired[stringList]

The Amazon Resource Names (ARNs) of the frameworks a report covers.

number_of_frameworks instance-attribute 

number_of_frameworks: integer

The number of frameworks a report covers.

organization_units instance-attribute 

organization_units: NotRequired[stringList]

These are the Organizational Units to be included in the report.

regions instance-attribute 

regions: NotRequired[stringList]

These are the Regions to be included in the report.

Use the wildcard as the string value to include all Regions.

report_template instance-attribute 

report_template: string

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 | SCAN_JOB_REPORT