Skip to content

ReportJob

Source code in docs_src/capo_backup/types/report_job.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class ReportJob(TypedDict, closed=True):
    report_job_id: NotRequired["capo_backup.types.report_job_id.ReportJobId"]
    """<p>The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.</p>"""
    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_template: NotRequired["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</code> </p>"""
    creation_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a report job 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>"""
    completion_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    status: NotRequired["capo_backup.types.string.string"]
    """<p>The status of a report job. The statuses are:</p> <p> <code>CREATED | RUNNING | COMPLETED | FAILED</code> </p> <p> <code>COMPLETED</code> means that the report is available for your review at your designated destination. If the status is <code>FAILED</code>, review the <code>StatusMessage</code> for the reason.</p>"""
    status_message: NotRequired["capo_backup.types.string.string"]
    """<p>A message explaining the status of the report job.</p>"""
    report_destination: NotRequired[
        "capo_backup.types.report_destination.ReportDestination"
    ]
    """<p>The S3 bucket name and S3 keys for the destination where the report job publishes the report.</p>"""

completion_time instance-attribute 

completion_time: NotRequired[timestamp]

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

creation_time instance-attribute 

creation_time: NotRequired[timestamp]

The date and time that a report job 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_destination instance-attribute 

report_destination: NotRequired[ReportDestination]

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

report_job_id instance-attribute 

report_job_id: NotRequired[ReportJobId]

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

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

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

status instance-attribute 

status: NotRequired[string]

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

status_message instance-attribute 

status_message: NotRequired[string]

A message explaining the status of the report job.