Skip to content

JobReport

Source code in docs_src/capo_s3_control/types/job_report.py
class JobReport(TypedDict, closed=True):
    bucket: NotRequired["capo_s3_control.types.s3_bucket_arn_string.S3BucketArnString"]
    """<p>The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.</p> <note> <p> <b>Directory buckets</b> - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.</p> </note>"""
    format: NotRequired["capo_s3_control.types.job_report_format.JobReportFormat"]
    """<p>The format of the specified job-completion report.</p>"""
    enabled: "capo_s3_control.types.boolean.Boolean"
    """<p>Indicates whether the specified job will generate a job-completion report.</p>"""
    prefix: NotRequired["capo_s3_control.types.report_prefix_string.ReportPrefixString"]
    """<p>An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <code><prefix>/job-<job-id>/report.json</code>.</p>"""
    report_scope: NotRequired["capo_s3_control.types.job_report_scope.JobReportScope"]
    """<p>Indicates whether the job-completion report will include details of all tasks or only failed tasks.</p>"""
    expected_bucket_owner: NotRequired["capo_s3_control.types.account_id.AccountId"]
    """<p>Lists the Amazon Web Services account ID that owns the target bucket, where the completion report is received.</p>"""

bucket instance-attribute

bucket: NotRequired[S3BucketArnString]

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Directory buckets - Directory buckets aren't supported as a location for Batch Operations to store job completion reports.

enabled instance-attribute

enabled: Boolean

Indicates whether the specified job will generate a job-completion report.

expected_bucket_owner instance-attribute

expected_bucket_owner: NotRequired[AccountId]

Lists the Amazon Web Services account ID that owns the target bucket, where the completion report is received.

format instance-attribute

format: NotRequired[JobReportFormat]

The format of the specified job-completion report.

prefix instance-attribute

prefix: NotRequired[ReportPrefixString]

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at /job-/report.json.

report_scope instance-attribute

report_scope: NotRequired[JobReportScope]

Indicates whether the job-completion report will include details of all tasks or only failed tasks.