Skip to content

ReportPlan

Source code in docs_src/capo_backup/types/report_plan.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class ReportPlan(TypedDict, closed=True):
    report_plan_arn: NotRequired["capo_backup.types.arn.ARN"]
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"""
    report_plan_name: NotRequired["capo_backup.types.report_plan_name.ReportPlanName"]
    """<p>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 (_).</p>"""
    report_plan_description: NotRequired[
        "capo_backup.types.report_plan_description.ReportPlanDescription"
    ]
    """<p>An optional description of the report plan with a maximum 1,024 characters.</p>"""
    report_setting: NotRequired["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</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_delivery_channel: NotRequired[
        "capo_backup.types.report_delivery_channel.ReportDeliveryChannel"
    ]
    """<p>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>"""
    deployment_status: NotRequired["capo_backup.types.string.string"]
    """<p>The deployment status of a report plan. The statuses are:</p> <p> <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED</code> </p>"""
    creation_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    last_attempted_execution_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>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 <code>LastAttemptedExecutionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    last_successful_execution_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>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 <code>LastSuccessfulExecutionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""

creation_time instance-attribute 

creation_time: NotRequired[timestamp]

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.

deployment_status instance-attribute 

deployment_status: NotRequired[string]

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

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

last_attempted_execution_time instance-attribute 

last_attempted_execution_time: NotRequired[timestamp]

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.

last_successful_execution_time instance-attribute 

last_successful_execution_time: NotRequired[timestamp]

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_delivery_channel instance-attribute 

report_delivery_channel: NotRequired[ReportDeliveryChannel]

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_arn instance-attribute 

report_plan_arn: NotRequired[ARN]

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

report_plan_description instance-attribute 

report_plan_description: NotRequired[ReportPlanDescription]

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

report_plan_name instance-attribute 

report_plan_name: NotRequired[ReportPlanName]

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_setting instance-attribute 

report_setting: NotRequired[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

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.