# 用於大量佈建的 AWS IoT Core for Amazon Sidewalk API 操作
您可執行下列 API 操作，以大量佈建 Sidewalk 終端裝置：
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_StartWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_StartWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/start-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/start-wireless-device-import-task.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_StartSingleWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_StartSingleWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/start-single-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/start-single-wireless-device-import-task.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListWirelessDeviceImportTasks.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListWirelessDeviceImportTasks.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/list-wireless-device-import-tasks.html](https://docs.aws.amazon.com/cli/latest/reference/list-wireless-device-import-tasks.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListDevicesForWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListDevicesForWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/list-devices-for-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/list-devices-for-wireless-device-import-task.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/get-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/get-wireless-device-import-task.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/update-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/update-wireless-device-import-task.html) CLI
+ [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_DeleteWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_DeleteWirelessDeviceImportTask.html) API 或 [https://docs.aws.amazon.com/cli/latest/reference/delete-wireless-device-import-task.html](https://docs.aws.amazon.com/cli/latest/reference/delete-wireless-device-import-task.html) CLI
下列各節展示如何取得、列出、更新及和刪除匯入任務。如需建立匯入任務的相關資訊，請參閱 [用於大量佈建的 AWS IoT Core for Amazon Sidewalk API 操作](#iot-sidewalk-apis-provisioning)。
## 取得匯入任務的資訊
您可以使用 [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListDevicesForWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_ListDevicesForWirelessDeviceImportTask.html) 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"
},
}
]
}
```
## 取得匯入任務裝置摘要
如要取得新增至特定匯入任務之裝置加入狀態的摘要資訊計數，請使用 [https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetWirelessDeviceImportTask.html](https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetWirelessDeviceImportTask.html) 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 操作。