IoT Analytics connector

The amount of memory (in KB) to allocate to this connector.

Display name in the Amazon IoT console: Memory size

Required: true

Type: string

Valid pattern: ^[0-9]+$

The Amazon Web Services Region that your Amazon IoT Analytics channels are created in. Use the same Region as the connector.

Display name in the Amazon IoT console: Publish region

Required: false

Type: string

Valid pattern: ^$|([a-z]{2}-[a-z]+-\\d{1})

The interval (in seconds) for publishing a batch of received data to Amazon IoT Analytics.

Display name in the Amazon IoT console: Publish interval

Required: false

Type: string

Default value: 1

Valid pattern: $|^[0-9]+$

The maximum number of Amazon IoT Analytics channels that the connector actively watches for. This must be greater than 0, and at least equal to the number of channels that you expect the connector to publish to at a given time.

You can use this parameter to restrict memory consumption by limiting the total number of queues that the connector can manage at a given time. A queue is deleted when all queued messages are sent.

Display name in the Amazon IoT console: Maximum number of active channels

Required: false

Type: string

Default value: 50

Valid pattern: ^$|^[1-9][0-9]*$

The behavior for dropping messages from a channel queue when the queue is full.

Display name in the Amazon IoT console: Queue drop behavior

Required: false

Type: string

Valid values: DROP_NEWEST or DROP_OLDEST

Default value: DROP_NEWEST

Valid pattern: ^DROP_NEWEST$|^DROP_OLDEST$

The maximum number of messages to retain in memory (per channel) before the messages are submitted or dropped. This must be greater than 0.

Display name in the Amazon IoT console: Maximum queue size per channel

Required: false

Type: string

Default value: 2048

Valid pattern: ^$|^[1-9][0-9]*$

The maximum number of messages to send to an Amazon IoT Analytics channel in one batch request. This must be greater than 0.

Display name in the Amazon IoT console: Maximum number of messages to batch per channel

Required: false

Type: string

Default value: 5

Valid pattern: ^$|^[1-9][0-9]*$

The name of the Amazon IoT Analytics channel that this connector uses for messages that are sent to a customer-defined input topic.

Display name in the Amazon IoT console: Default channel name

Required: false

Type: string

Valid pattern: ^[a-zA-Z0-9_]$

The containerization mode for this connector. The default is GreengrassContainer, which means that the connector runs in an isolated runtime environment inside the Amazon IoT Greengrass container.

Display name in the Amazon IoT console: Container isolation mode

Required: false

Type: string

Valid values: GreengrassContainer or NoContainer

Valid pattern: ^NoContainer$|^GreengrassContainer$

The connector supports the following two structured MQTT topics that allow publishers to specify the channel name inline.

The connector supports the # topic syntax, which allows it to accept input messages on any MQTT topic that you configure in a subscription. We recommend that you specify a topic path instead of using only the # wildcard in your subscriptions. These messages are sent to the default channel that you specify for the connector.

Input messages on customer-defined topics are treated as binary data. They can use any message format and can contain any data type. You can use customer-defined topics to route messages from devices that publish to fixed topics. You can also use them to accept input data from client devices that can't process the data into a formatted message to send to the connector.

For more information about subscriptions and MQTT topics, see Inputs and outputs.

Use this topic to send formatted messages to the connector and dynamically specify a destination channel. This topic also allows you to specify an ID that's returned in the response output. The connector verifies that IDs are unique for each message in the outbound BatchPutMessage request that it sends to Amazon IoT Analytics. A message that has a duplicate ID is dropped.

Input data sent to this topic must use the following message format.

Use this topic to send unformatted messages to the connector and dynamically specify a destination channel.

The connector data doesn't parse the input messages received on this topic. It treats them as binary data. Before sending the messages to Amazon IoT Analytics, the connector encodes and formats them to conform with BatchPutMessage API requirements:

Use this topic to send any message format to the default channel. This is especially useful when your client devices publish to fixed topics or when you want to send data to the default channel from client devices that can't process the data into the connector's supported message format.

You define the topic syntax in the subscription that you create to connect this connector to the data source. We recommend that you specify a topic path instead of using only the # wildcard in your subscriptions.

The connector data doesn't parse the messages that are published to this input topic. All input messages are treated as binary data. Before sending the messages to Amazon IoT Analytics, the connector encodes and formats them to conform with BatchPutMessage API requirements:

iotanalytics/messages/put/status

{
    "response" : {
        "status" : "success"
    },
    "id" : "req123"
}

{
    "response" : {
        "status" : "fail",
        "error" : "ResourceNotFoundException",
        "error_message" : "A resource with the specified name could not be found."
    },
    "id" : "req123"
}