BatchConfig
Configuration settings for batching.
Contents
- batchAcrossTopics
-
Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is
false.Note
When
batchAcrossTopicsis enabled, the error payload format changes: thetopicfield moves from the top level to inside each entry in thepayloadsWithMetadataarray, since each message in the batch may originate from a different topic.Note
Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the
batchAcrossTopicssetting.Type: Boolean
Required: No
- maxBatchOpenMs
-
The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 200.
Required: No
- maxBatchSize
-
The maximum number of messages that are batched together in a single action execution.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 10.
Required: No
- maxBatchSizeBytes
-
Maximum size of a message batch, in bytes.
Type: Integer
Valid Range: Minimum value of 100. Maximum value of 131072.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
