Skip to content

S3OutputFormatConfig

Source code in docs_src/capo_appflow/types/s3_output_format_config.py
class S3OutputFormatConfig(TypedDict, closed=True):
    file_type: NotRequired["capo_appflow.types.file_type.FileType"]
    """<p> Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. </p>"""
    prefix_config: NotRequired["capo_appflow.types.prefix_config.PrefixConfig"]
    """<p> Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date. </p>"""
    aggregation_config: NotRequired[
        "capo_appflow.types.aggregation_config.AggregationConfig"
    ]
    preserve_source_data_typing: NotRequired[
        "capo_appflow.types.java_boolean.JavaBoolean"
    ]
    """<p>If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3. </p> <ul> <li> <p> <code>true</code>: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or <code>1</code> in your source data is still an integer in your output.</p> </li> <li> <p> <code>false</code>: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of <code>1</code> in your source data becomes the string <code>"1"</code> in the output.</p> </li> </ul>"""

aggregation_config instance-attribute

aggregation_config: NotRequired[AggregationConfig]

file_type instance-attribute

file_type: NotRequired[FileType]

Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

prefix_config instance-attribute

prefix_config: NotRequired[PrefixConfig]

Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

preserve_source_data_typing instance-attribute

preserve_source_data_typing: NotRequired[JavaBoolean]

If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

  • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.

  • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.