Skip to content

CreateReportPlanInput

Source code in docs_src/capo_backup/types/create_report_plan_input.py
class CreateReportPlanInput(TypedDict, closed=True):
    report_plan_name: "capo_backup.types.report_plan_name.ReportPlanName"
    """<p>The 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 (_).</p>"""
    report_plan_description: NotRequired[
        "capo_backup.types.report_plan_description.ReportPlanDescription"
    ]
    """<p>An optional description of the report plan with a maximum of 1,024 characters.</p>"""
    report_delivery_channel: (
        "capo_backup.types.report_delivery_channel.ReportDeliveryChannel"
    )
    """<p>A 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.</p>"""
    report_setting: "capo_backup.types.report_setting.ReportSetting"
    """<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> <p>If the report template is <code>RESOURCE_COMPLIANCE_REPORT</code> or <code>CONTROL_COMPLIANCE_REPORT</code>, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.</p>"""
    report_plan_tags: NotRequired["capo_backup.types.string_map.stringMap"]
    """<p>The tags to assign to the report plan.</p>"""
    idempotency_token: NotRequired["capo_backup.types.string.string"]
    """<p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>"""

idempotency_token instance-attribute

idempotency_token: NotRequired[string]

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

report_delivery_channel instance-attribute

report_delivery_channel: ReportDeliveryChannel

A 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_plan_description instance-attribute

report_plan_description: NotRequired[ReportPlanDescription]

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

report_plan_name instance-attribute

report_plan_name: ReportPlanName

The 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_tags instance-attribute

report_plan_tags: NotRequired[stringMap]

The tags to assign to the report plan.

report_setting instance-attribute

report_setting: ReportSetting

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

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.