Skip to content

CSV

Source code in docs_src/capo_cloudwatch_logs/types/csv.py
class CSV(TypedDict, closed=True):
    quote_character: NotRequired[
        "capo_cloudwatch_logs.types.quote_character.QuoteCharacter"
    ]
    """<p>The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark <code>"</code> character is used.</p>"""
    delimiter: NotRequired["capo_cloudwatch_logs.types.delimiter.Delimiter"]
    """<p>The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma <code>,</code> character as the delimiter.</p>"""
    columns: NotRequired["capo_cloudwatch_logs.types.columns.Columns"]
    """<p>An array of names to use for the columns in the transformed log event.</p> <p>If you omit this, default column names (<code>[column_1, column_2 ...]</code>) are used.</p>"""
    source: NotRequired["capo_cloudwatch_logs.types.source.Source"]
    """<p>The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.</p>"""
    destination: NotRequired[
        "capo_cloudwatch_logs.types.destination_field.DestinationField"
    ]
    """<p>The path to the parent field to put transformed key value pairs under. If you omit this value, the key value pairs will be placed under the root node.</p>"""

columns instance-attribute

columns: NotRequired[Columns]

An array of names to use for the columns in the transformed log event.

If you omit this, default column names ([column_1, column_2 ...]) are used.

delimiter instance-attribute

delimiter: NotRequired[Delimiter]

The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.

destination instance-attribute

destination: NotRequired[DestinationField]

The path to the parent field to put transformed key value pairs under. If you omit this value, the key value pairs will be placed under the root node.

quote_character instance-attribute

quote_character: NotRequired[QuoteCharacter]

The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark " character is used.

source instance-attribute

source: NotRequired[Source]

The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.