Skip to content

CSVOutput

Source code in docs_src/capo_s3/types/csv_output.py
class CSVOutput(TypedDict, closed=True):
    quote_fields: NotRequired["capo_s3.types.quote_fields.QuoteFields"]
    """<p>Indicates whether to use quotation marks around output fields. </p> <ul> <li> <p> <code>ALWAYS</code>: Always use quotation marks for output fields.</p> </li> <li> <p> <code>ASNEEDED</code>: Use quotation marks for output fields when needed.</p> </li> </ul>"""
    quote_escape_character: NotRequired[
        "capo_s3.types.quote_escape_character.QuoteEscapeCharacter"
    ]
    """<p>The single character used for escaping the quote character inside an already escaped value.</p>"""
    record_delimiter: NotRequired["capo_s3.types.record_delimiter.RecordDelimiter"]
    """<p>A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.</p>"""
    field_delimiter: NotRequired["capo_s3.types.field_delimiter.FieldDelimiter"]
    """<p>The value used to separate individual fields in a record. You can specify an arbitrary delimiter.</p>"""
    quote_character: NotRequired["capo_s3.types.quote_character.QuoteCharacter"]
    """<p>A single character used for escaping when the field delimiter is part of the value. For example, if the value is <code>a, b</code>, Amazon S3 wraps this field value in quotation marks, as follows: <code>" a , b "</code>.</p>"""

field_delimiter instance-attribute

field_delimiter: NotRequired[FieldDelimiter]

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

quote_character instance-attribute

quote_character: NotRequired[QuoteCharacter]

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

quote_escape_character instance-attribute

quote_escape_character: NotRequired[QuoteEscapeCharacter]

The single character used for escaping the quote character inside an already escaped value.

quote_fields instance-attribute

quote_fields: NotRequired[QuoteFields]

Indicates whether to use quotation marks around output fields.

  • ALWAYS: Always use quotation marks for output fields.

  • ASNEEDED: Use quotation marks for output fields when needed.

record_delimiter instance-attribute

record_delimiter: NotRequired[RecordDelimiter]

A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.