Skip to content

PipeSourceKinesisStreamParameters

Source code in docs_src/capo_pipes/types/pipe_source_kinesis_stream_parameters.py
class PipeSourceKinesisStreamParameters(TypedDict, closed=True):
    batch_size: NotRequired["capo_pipes.types.limit_max10000.LimitMax10000"]
    """<p>The maximum number of records to include in each batch.</p>"""
    dead_letter_config: NotRequired[
        "capo_pipes.types.dead_letter_config.DeadLetterConfig"
    ]
    """<p>Define the target queue to send dead-letter queue events to.</p>"""
    on_partial_batch_item_failure: NotRequired[
        "capo_pipes.types.on_partial_batch_item_failure_streams.OnPartialBatchItemFailureStreams"
    ]
    """<p>Define how to handle item process failures. <code>AUTOMATIC_BISECT</code> halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.</p>"""
    maximum_batching_window_in_seconds: NotRequired[
        "capo_pipes.types.maximum_batching_window_in_seconds.MaximumBatchingWindowInSeconds"
    ]
    """<p>The maximum length of a time to wait for events.</p>"""
    maximum_record_age_in_seconds: NotRequired[
        "capo_pipes.types.maximum_record_age_in_seconds.MaximumRecordAgeInSeconds"
    ]
    """<p>Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. </p>"""
    maximum_retry_attempts: NotRequired[
        "capo_pipes.types.maximum_retry_attempts_esm.MaximumRetryAttemptsESM"
    ]
    """<p>Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.</p>"""
    parallelization_factor: NotRequired["capo_pipes.types.limit_max10.LimitMax10"]
    """<p>The number of batches to process concurrently from each shard. The default value is 1.</p>"""
    starting_position: (
        "capo_pipes.types.kinesis_stream_start_position.KinesisStreamStartPosition"
    )
    """<p>The position in a stream from which to start reading.</p>"""
    starting_position_timestamp: NotRequired["capo_pipes.types.timestamp.Timestamp"]
    """<p>With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start reading, in Unix time seconds.</p>"""

batch_size instance-attribute

batch_size: NotRequired[LimitMax10000]

The maximum number of records to include in each batch.

dead_letter_config instance-attribute

dead_letter_config: NotRequired[DeadLetterConfig]

Define the target queue to send dead-letter queue events to.

maximum_batching_window_in_seconds instance-attribute

maximum_batching_window_in_seconds: NotRequired[MaximumBatchingWindowInSeconds]

The maximum length of a time to wait for events.

maximum_record_age_in_seconds instance-attribute

maximum_record_age_in_seconds: NotRequired[MaximumRecordAgeInSeconds]

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

maximum_retry_attempts instance-attribute

maximum_retry_attempts: NotRequired[MaximumRetryAttemptsESM]

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

on_partial_batch_item_failure instance-attribute

on_partial_batch_item_failure: NotRequired[OnPartialBatchItemFailureStreams]

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

parallelization_factor instance-attribute

parallelization_factor: NotRequired[LimitMax10]

The number of batches to process concurrently from each shard. The default value is 1.

starting_position instance-attribute

starting_position: KinesisStreamStartPosition

The position in a stream from which to start reading.

starting_position_timestamp instance-attribute

starting_position_timestamp: NotRequired[Timestamp]

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.