AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Configuration settings for batching.

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.BatchConfig

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class BatchConfig

The BatchConfig type exposes the following members

Constructors

NameDescription
Public Method BatchConfig()

Properties

NameTypeDescription
Public Property BatchAcrossTopics System.Nullable<System.Boolean>

Gets and sets the property 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.

When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic.

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 batchAcrossTopics setting.

Public Property MaxBatchOpenMs System.Nullable<System.Int32>

Gets and sets the property 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.

Public Property MaxBatchSize System.Nullable<System.Int32>

Gets and sets the property MaxBatchSize.

The maximum number of messages that are batched together in a single action execution.

Public Property MaxBatchSizeBytes System.Nullable<System.Int32>

Gets and sets the property MaxBatchSizeBytes.

Maximum size of a message batch, in bytes.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer