Skip to content

IngestionS3InputConfiguration

Source code in docs_src/capo_lookoutequipment/types/ingestion_s3_input_configuration.py
class IngestionS3InputConfiguration(TypedDict, closed=True):
    bucket: "capo_lookoutequipment.types.s3_bucket.S3Bucket"
    """<p>The name of the S3 bucket used for the input data for the data ingestion. </p>"""
    prefix: NotRequired["capo_lookoutequipment.types.s3_prefix.S3Prefix"]
    """<p>The prefix for the S3 location being used for the input data for the data ingestion. </p>"""
    key_pattern: NotRequired["capo_lookoutequipment.types.key_pattern.KeyPattern"]
    """<p> The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.</p> <p>Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)</p>"""

bucket instance-attribute

bucket: S3Bucket

The name of the S3 bucket used for the input data for the data ingestion.

key_pattern instance-attribute

key_pattern: NotRequired[KeyPattern]

The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

prefix instance-attribute

prefix: NotRequired[S3Prefix]

The prefix for the S3 location being used for the input data for the data ingestion.