Skip to content

BatchConfiguration

Source code in docs_src/capo_eventbridgev2/types/batch_configuration.py
class BatchConfiguration(TypedDict, closed=True):
    max_batch_size: NotRequired[
        "capo_eventbridgev2.types.nullable_integer.NullableInteger"
    ]
    """The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read."""
    max_batch_window_in_seconds: NotRequired[
        "capo_eventbridgev2.types.nullable_integer.NullableInteger"
    ]
    """The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read."""

max_batch_size instance-attribute

max_batch_size: NotRequired[NullableInteger]

The maximum number of events to include in a single batch delivered to the target. The service delivers up to this many events per batch; fewer may be delivered when the batch window elapses or the target's per-batch limit is smaller. This is a maximum, not a guaranteed count. Valid range is 1-500 (default: 10, or the target API's per-batch maximum). The resolved value applied by the service is returned on read.

max_batch_window_in_seconds instance-attribute

max_batch_window_in_seconds: NotRequired[NullableInteger]

The maximum time in seconds to wait for a batch to fill before delivering it to the target. This is a maximum; a batch may be delivered sooner if it reaches MaxBatchSize or another delivery condition is met. Valid range is 0-300 (default: 0, meaning no wait). The resolved value applied by the service is always returned on read.