IoT Analytics コネクタ

このコネクタに割り当てるメモリ量 (KB 単位)。

AWS IoT コンソールでの表示名: [Memory size] (メモリサイズ)

必須: true

タイプ: string

有効なパターン: ^[0-9]+$

AWS IoT Analytics チャネルが作成された AWS リージョン。コネクタと同じリージョンを使用します。

AWS IoT コンソールでの表示名: [Publish region] (発行リージョン)

必須: false

タイプ: string

有効なパターン: ^$|([a-z]{2}-[a-z]+-\\d{1})

受信したデータのバッチを AWS IoT Analytics に発行する間隔 (秒単位)。

AWS IoT コンソールでの表示名: [Publish interval] (発行間隔)

必須: false

タイプ: string

デフォルト値: 1

有効なパターン: $|^[0-9]+$

コネクタがアクティブに監視する AWS IoT Analytics チャネルの最大数。これは 0 より大きい必要があり、少なくとも、コネクタが同時に発行することが予期されるチャネル数と同じである必要があります。

このパラメータを使用すると、コネクタが同時に管理できるキューの合計数を限定して、メモリ消費量を制限することができます。キューに入れられたすべてのメッセージが送信されると、キューは削除されます。

AWS IoT コンソールでの表示名: [Maximum number of active channels] (アクティブなチャネルの最大数)

必須: false

タイプ: string

デフォルト値: 50

有効なパターン: ^$|^[1-9][0-9]*$

キューがいっぱいであるときに、チャネルキューからメッセージを削除する動作。

AWS IoT コンソールでの表示名: [Queue drop behavior] (キューの削除動作)

必須: false

タイプ: string

有効な値: DROP_NEWEST または DROP_OLDEST

デフォルト値: DROP_NEWEST

有効なパターン: ^DROP_NEWEST$|^DROP_OLDEST$

メッセージが送信または削除される前に、メモリに保持するされるメッセージの最大数 (1 チャネルあたり)。0 より大きくする必要があります。

AWS IoT コンソールでの表示名: [Maximum queue size per channel] (チャネルあたりの最大キューサイズ)

必須: false

タイプ: string

デフォルト値: 2048

有効なパターン: ^$|^[1-9][0-9]*$

1 つのバッチリクエストで AWS IoT Analytics チャネルに送信するメッセージの最大数。0 より大きくする必要があります。

AWS IoT コンソールでの表示名: [Maximum number of messages to batch per channel] (チャネルあたりのバッチへのメッセージの最大数)

必須: false

タイプ: string

デフォルト値: 5

有効なパターン: ^$|^[1-9][0-9]*$

お客様定義の入力トピックに送信されるメッセージに対して、このコネクタが使用する AWS IoT Analytics チャネルの名前。

AWS IoT コンソールでの表示名: [Default channel name] (デフォルトのチャンネル名)　

必須: false

タイプ: string

有効なパターン: ^[a-zA-Z0-9_]$

このコネクタのコンテナ化モード。デフォルトは GreengrassContainer です。つまり、コネクタは AWS IoT Greengrass コンテナ内の分離されたランタイム環境で実行されます。

AWS IoT コンソールでの表示名: [Container isolation mode] (コンテナ分離モード)　

必須: false

タイプ: string

有効な値: GreengrassContainer または NoContainer

有効なパターン: ^NoContainer$|^GreengrassContainer$

コネクタは、発行者がチャネル名をインラインで定義できる、次の 2 つの構造化された MQTT トピックをサポートします。

コネクタは # トピック構文をサポートします。これにより、サブスクリプションで設定する任意の MQTT トピックで入力メッセージを受け入れることができます。サブスクリプションでは、# ワイルドカードのみを使用する代わりに、トピックパスを指定することをお勧めします。これらのメッセージは、コネクタに指定したデフォルトのチャネルに送信されます。

お客様定義のトピックの入力メッセージはバイナリデータとして処理されます。任意のメッセージ形式を使用し、任意のデータ型を含めることができます。お客様定義のトピックを使用すると、固定されたトピックに発行するデバイスからメッセージをルーティングできます。また、それらのトピックを使用して、データを処理できないクライアントデバイスから入力データをフォーマットされたメッセージに受け入れ、コネクタに送信することもできます。

サブスクリプションと MQTT トピックの詳細については、「入力と出力」を参照してください。

このトピックを使用して、フォーマットされたメッセージをコネクタに送信し、動的に送信先チャネルを指定します。このトピックでは、応答出力で返される ID を指定することもできます。コネクタは、AWS IoT Analytics に送信するアウトバウンド BatchPutMessage リクエストで、各メッセージの固有の ID を検証します。ID が重複しているメッセージは削除されます。

このトピックに送信される入力データは、次のメッセージ形式を使用します。

このトピックを使用して、フォーマットされていないメッセージをコネクタに送信し、動的に送信先チャネルを指定します。

コネクタのデータにより、このトピックで受信された入力メッセージは解析されません。これは、バイナリデータとして扱われます。AWS IoT Analytics にメッセージを送信する前にコネクタはメッセージをエンコードし、BatchPutMessage API の要件に準拠するようにフォーマットします。

このトピックを使用して、任意のメッセージ形式をデフォルトのチャネルに送信します。これが特に役立つのは、クライアントデバイスが固定されたトピックに発行するときや、コネクタでサポートされているメッセージ形式にデータを処理できないクライアントデバイスからデフォルトのチャネルにデータを送信する場合です。

トピック構文は、このコネクタをデータソースに接続するために作成するサブスクリプションで定義します。サブスクリプションでは、# ワイルドカードのみを使用する代わりに、トピックパスを指定することをお勧めします。

コネクタのデータにより、この入力トピックに公開されるメッセージは解析されません。すべての入力メッセージはバイナリデータとして扱われます。AWS IoT Analytics にメッセージを送信する前にコネクタはメッセージをエンコードし、BatchPutMessage API の要件に準拠するようにフォーマットします。

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"
}