Skip to content

S3JobManifestGenerator

Source code in docs_src/capo_s3_control/types/s3_job_manifest_generator.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class S3JobManifestGenerator(TypedDict, closed=True):
    expected_bucket_owner: NotRequired["capo_s3_control.types.account_id.AccountId"]
    """<p>The Amazon Web Services account ID that owns the source bucket specified in <code>SourceBucket</code>. If provided, the manifest source bucket owner's Amazon Web Services account ID must match this value, else the job fails.</p>"""
    source_bucket: "capo_s3_control.types.s3_bucket_arn_string.S3BucketArnString"
    """<p>The ARN of the source bucket used by the ManifestGenerator.</p> <note> <p> <b>Directory buckets</b> - Directory buckets aren't supported as the source buckets used by <code>S3JobManifestGenerator</code> to generate the job manifest.</p> </note>"""
    manifest_output_location: NotRequired[
        "capo_s3_control.types.s3_manifest_output_location.S3ManifestOutputLocation"
    ]
    """<p>Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html">Directory buckets</a>.</p>"""
    filter: NotRequired[
        "capo_s3_control.types.job_manifest_generator_filter.JobManifestGeneratorFilter"
    ]
    """<p>Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.</p>"""
    enable_manifest_output: "capo_s3_control.types.boolean.Boolean"
    """<p>Determines whether or not to write the job's generated manifest to a bucket.</p>"""

enable_manifest_output instance-attribute 

enable_manifest_output: Boolean

Determines whether or not to write the job's generated manifest to a bucket.

expected_bucket_owner instance-attribute 

expected_bucket_owner: NotRequired[AccountId]

The Amazon Web Services account ID that owns the source bucket specified in SourceBucket. If provided, the manifest source bucket owner's Amazon Web Services account ID must match this value, else the job fails.

filter instance-attribute 

filter: NotRequired[JobManifestGeneratorFilter]

Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

manifest_output_location instance-attribute 

manifest_output_location: NotRequired[S3ManifestOutputLocation]

Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see Directory buckets.

source_bucket instance-attribute 

source_bucket: S3BucketArnString

The ARN of the source bucket used by the ManifestGenerator.

Directory buckets - Directory buckets aren't supported as the source buckets used by S3JobManifestGenerator to generate the job manifest.