Skip to content

FirehoseAction

Source code in docs_src/capo_iot_events/types/firehose_action.py
class FirehoseAction(TypedDict, closed=True):
    delivery_stream_name: (
        "capo_iot_events.types.delivery_stream_name.DeliveryStreamName"
    )
    """<p>The name of the Kinesis Data Firehose delivery stream where the data is written.</p>"""
    separator: NotRequired["capo_iot_events.types.firehose_separator.FirehoseSeparator"]
    r"""<p>A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).</p>"""
    payload: NotRequired["capo_iot_events.types.payload.Payload"]
    """<p>You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.</p>"""

delivery_stream_name instance-attribute

delivery_stream_name: DeliveryStreamName

The name of the Kinesis Data Firehose delivery stream where the data is written.

payload instance-attribute

payload: NotRequired[Payload]

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

separator instance-attribute

separator: NotRequired[FirehoseSeparator]

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).