一括プロビジョニングの AWS IoT Core for Amazon Sidewalk API オペレーション - AWS IoT Wireless
インポートタスクの情報を取得するインポートタスクデバイスの概要を取得するデバイスをインポートタスクに追加するAWS アカウント 内のインポートタスクを一覧表示するインポートタスクを AWS アカウント から削除する

一括プロビジョニングの AWS IoT Core for Amazon Sidewalk API オペレーション

Sidewalk エンドデバイスを一括プロビジョニングするには、次の API オペレーションを実行します。

次のセクションでは、インポートタスクの取得、一覧表示、更新、削除の方法について説明します。インポートタスクの作成に関する詳細については、「一括プロビジョニングの AWS IoT Core for Amazon Sidewalk API オペレーション」を参照してください。

インポートタスクの情報を取得する

ListDevicesForWirelessDeviceImportTask API オペレーションを使用して、特定のインポートタスクとそのタスク内のデバイスのオンボーディングステータスに関する情報を取得できます。API オペレーションの入力として、StartWirelessDeviceImportTask または StartSingleWirelessDeviceImportTask API オペレーションから取得したインポートタスク ID を指定します。その後、API は指定された識別子に一致するインポートタスクに関する情報を返します。

CLI コマンドの例を以下に示します。

aws iotwireless list-devices-for-wireless-device-import-task --id e2a5995e-743b-41f2-a1e4-3ca6a5c5249f

このコマンドを実行すると、インポートタスクの情報とデバイスのオンボーディングステータスが返されます。

{
   "DestinationName": "SidewalkDestination",
   "ImportedWirelessDeviceList": [ 
      { 
         "Sidewalk": { 
            "OnboardingStatus": "ONBOARDED",
            "LastUpdateTime": "2023-02021T06:11:09.151Z",
            "SidewalkManufacturingSn": "82B83C8B35E856F43CE9C3D59B418CC96B996071016DB1C3BE5901F0F3071A4A"
         },
         "Sidewalk": {
             "OnboardingStatus": "PENDING",
             "LastUpdateTime": "2023-02021T06:22:12.061Z",
             "SidewalkManufacturingSn": "12345ABCDE6789FABDESBDEF123456789012345FEABC0123679AFEBC01234EF"
         },        
      }
   ]
}

インポートタスクデバイスの概要を取得する

特定のインポートタスクに追加したデバイスのオンボーディングステータスの概要情報の数を取得するには、GetWirelessDeviceImportTask API オペレーションを使用します。CLI コマンドの例を以下に示します。

aws iotwireless get-wireless-device-import-task --Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f"

以下のコードは、コマンドからのレスポンスの例を示しています。

{
   "NumberOfFailedImportedDevices": 2,
   "NumberOfOnboardedImportedDevices": 4,
   "NumberOfPendingImportedDevices": 1
}

デバイスをインポートタスクに追加する

UpdateWirelessDeviceImportTask API オペレーションを使用して、追加した既存のインポートタスクにデバイスを追加します。この API オペレーションを使用して、StartWirelessDeviceImportTask API オペレーションを使用して作成したタスクにこれまで含まれていなかったデバイスのシリアル番号 (SMSN) を追加できます。

デバイスをインポートタスクに追加するには、API リクエストの一部として、追加するデバイスのシリアル番号を含む Amazon S3 バケット内の新しい CSV ファイルを指定します。リクエストは、現在インポートタスクにあるデバイスのオンボーディングプロセスがまだ開始されていない場合にのみ受け付けられます。オンボーディングプロセスが既に開始されている場合、UpdateWirelessDeviceImportTask API リクエストは失敗します。

それでもインポートタスクにデバイスを追加したい場合は、UpdateWirelessDeviceImportTask API オペレーションをもう一度実行できます。この API オペレーションを実行する前に、最初の UpdateWirelessDeviceImportTask API リクエストで S3 バケット内の CSV ファイルの処理が完了している必要があります。

注記

ListImportedWirelessDeviceTasks API リクエストを実行しても、UpdateWirelessDeviceImportTask API オペレーションを使用して指定された新しい CSV ファイルの S3 URL は現在返されません。代わりに、API オペレーションは、StartWirelessDeviceImportTask API リクエストを使用して最初に送信されたリクエストの S3 URL を返します。

CLI コマンドの例を以下に示します。

aws iotwireless update-wireless-device-import task \
    --Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f" \
    --sidewalk '{"FileForCreateDevices": "s3://import_task_bucket/import_file3"}'

AWS アカウント 内のインポートタスクを一覧表示する

ListWirelessDeviceImportTasks API または list-imported-wireless-device-tasks CLI コマンドを使用して、AWS アカウント 内のインポートタスクを一覧表示します。CLI コマンドの例を以下に示します。

aws iotwireless list-wireless-device-import-tasks

このコマンドを実行すると、作成したインポートタスクのリストが返されます。リストには、Amazon S3 CSV ファイルと、指定された IAM ロール、インポートタスク ID、およびデバイスオンボーディングステータスの概要情報が含まれます。

{
   "ImportWirelessDeviceTaskList": [ 
      { 
         "FileForCreateDevices": "s3://import_task_bucket/import_file1",
         "ImportTaskId": "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f",
         "NumberOfFailedImportedDevices": 1,
         "NumberOfOnboardedImportedDevices": 3,
         "NumberOfPendingImportedDevices": 2,
         "Role": "arn:aws:iam::123456789012:role/service-role/ACF1zBEI",
         "TimeStamp": "1012202218:23:55"
      },
      { 
         "FileForCreateDevices": "s3://import_task_bucket/import_file2",
         "ImportTaskId": "a1b234c5-67ef-21a2-a1b2-3cd4e5f6789a",
         "NumberOfFailedImportedDevices": 2,
         "NumberOfOnboardedImportedDevices": 4,
         "NumberOfPendingImportedDevices": 1,
         "Role": "arn:aws:iam::123456789012:role/service-role/CDEFaBC1",
         "TimeStamp": "1201202210:12:20"
      }      
   ]
}

インポートタスクを AWS アカウント から削除する

インポートタスクを削除するには、インポートタスク ID を DeleteWirelessDeviceImportTask API オペレーションまたは delete-wireless-device-import-task CLI コマンドに渡します。

警告

削除の操作は元に戻せません。インポートタスクは AWS アカウント から完全に削除されます。

DeleteWirelessDeviceImportTask API リクエストを実行すると、バックグラウンドプロセスによってインポートタスクの削除が開始されます。リクエストが進行中の場合、インポートタスク内のデバイスのシリアル番号 (SMSN) は削除処理中となります。削除が完了した後にのみ、ListImportedWirelessDeviceTasks または GetImportedWirelessDeviceTasks API オペレーションを使用してこの情報を表示できるようになります。

インポートタスクにまだオンボーディング待ちのデバイスが含まれている場合、DeleteWirelessDeviceImportTask API リクエストは、インポートタスクのすべてのデバイスがオンボーディングされたか、オンボーディングに失敗した後にのみ処理されます。インポートタスクは 90 日後に期限切れになります。タスクの有効期限が切れると、アカウントから削除できます。ただし、インポートタスクを使用して正常にオンボーディングされたデバイスは削除されません。

注記

DeleteWirelessDeviceImportTask API リクエストを使用して、削除が保留されているデバイスのシリアル番号を含む別のインポートタスクを作成しようとすると、StartWirelessDeviceImportTask API オペレーションはエラーを返します。

CLI コマンドの例を以下に示します。

aws iotwireless delete-import-task --Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f"

このコマンドでは、出力が生成されません。タスクが削除された後、インポートタスクがアカウントから削除されたことを確認するには、GetWirelessDeviceImportTask API オペレーションまたは ListWirelessDeviceImportTasks API オペレーションを使用できます。