Skip to content

Output

Source code in docs_src/capo_databrew/types/output.py
class Output(TypedDict, closed=True):
    compression_format: NotRequired[
        "capo_databrew.types.compression_format.CompressionFormat"
    ]
    """<p>The compression algorithm used to compress the output text of the job.</p>"""
    format: NotRequired["capo_databrew.types.output_format.OutputFormat"]
    """<p>The data format of the output of the job.</p>"""
    partition_columns: NotRequired[
        "capo_databrew.types.column_name_list.ColumnNameList"
    ]
    """<p>The names of one or more partition columns for the output of the job.</p>"""
    location: "capo_databrew.types.s3_location.S3Location"
    """<p>The location in Amazon S3 where the job writes its output.</p>"""
    overwrite: "capo_databrew.types.overwrite_output.OverwriteOutput"
    """<p>A value that, if true, means that any data in the location specified for output is overwritten with new output.</p>"""
    format_options: NotRequired[
        "capo_databrew.types.output_format_options.OutputFormatOptions"
    ]
    """<p>Represents options that define how DataBrew formats job output files.</p>"""
    max_output_files: NotRequired["capo_databrew.types.max_output_files.MaxOutputFiles"]
    """<p>Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.</p>"""

compression_format instance-attribute

compression_format: NotRequired[CompressionFormat]

The compression algorithm used to compress the output text of the job.

format instance-attribute

format: NotRequired[OutputFormat]

The data format of the output of the job.

format_options instance-attribute

format_options: NotRequired[OutputFormatOptions]

Represents options that define how DataBrew formats job output files.

location instance-attribute

location: S3Location

The location in Amazon S3 where the job writes its output.

max_output_files instance-attribute

max_output_files: NotRequired[MaxOutputFiles]

Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.

overwrite instance-attribute

overwrite: OverwriteOutput

A value that, if true, means that any data in the location specified for output is overwritten with new output.

partition_columns instance-attribute

partition_columns: NotRequired[ColumnNameList]

The names of one or more partition columns for the output of the job.