モノのグループのインデックス作成の管理

AWS_ThingGroups は、すべてのモノのグループと請求グループを含むインデックスです。このインデックスを使用して、グループ名、説明、属性、すべての親グループ名に基づいてグループを検索することができます。

モノのグループのインデックス作成の有効化

Configuration API の UpdateIndexingthing-group-indexing-configuration設定を使用してAWS_ThingGroupsインデックスを作成し、その設定を制御できます。GetIndexingConfiguration API を使用して、現在のインデックス作成設定を取得できます。

モノのグループのインデックス作成設定を更新するには、update-indexing-configuration CLI コマンドを使用します。

aws iot update-indexing-configuration --thing-group-indexing-configuration thingGroupIndexingMode=ON

次のように、1 つのコマンドでモノとモノのグループのインデックス作成の両方の設定を更新することもできます。

aws iot update-indexing-configuration --thing-indexing-configuration thingIndexingMode=REGISTRY --thing-group-indexing-configuration thingGroupIndexingMode=ON

次に示すのは、thingGroupIndexingMode の有効な値です。

VOFF

インデックスの作成/インデックスの削除がありません。

ON

AWS_ThingGroups インデックスを作成または設定します。

現在のモノおよびモノのグループのインデックス作成設定を取得するには、get-indexing-configuration CLI コマンドを実行します。

aws iot get-indexing-configuration

コマンドのレスポンスは次のようになります。

{
   "thingGroupIndexingConfiguration": {
        "thingGroupIndexingMode": "ON"
    }
}

グループインデックスの説明

現在の AWS_ThingGroups インデックスのステータスを取得するには、describe-index CLI コマンドを使用します。

aws iot describe-index --index-name "AWS_ThingGroups"

コマンドのレスポンスは次のようになります。

{
   "indexStatus": "ACTIVE", 
   "indexName": "AWS_ThingGroups", 
   "schema": "THING_GROUPS"
}

AWS IoT は、インデックスを初めて作成するときにインデックスを構築します。indexStatus が BUILDING の場合、インデックスに対してクエリを実行することはできません。

モノのグループのインデックスのクエリ

インデックスのデータにクエリを実行するには、search-index CLI コマンドを使用します。

aws iot search-index --index-name "AWS_ThingGroups" --query-string "thingGroupName:mythinggroup*"

認証

次のように、 AWS IoT ポリシーアクションでモノのグループのインデックスをリソース ARN として指定できます。

アクション	リソース
iot:SearchIndex	インデックス ARN (例: arn:aws:iot:your-aws-region:index/AWS_ThingGroups)。
iot:DescribeIndex	インデックス ARN （例: arn:aws:iot:your-aws-region:index/AWS_ThingGroups）。