View a markdown version of this page

BatchConfiguration - Amazon EventBridge Custom Event Bus

BatchConfiguration

Batching configuration for a subscriber.

Contents

MaxBatchSize

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

MaxBatchWindowInSeconds

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 300.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: