# Opérations d’API AWS IoT Core pour Amazon Sidewalk pour la mise en service groupée
Vous pouvez effectuer les opérations d’API suivantes pour la mise en service groupée de vos terminaux 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 ou la [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 ou la [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 ou la [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 ou la [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 ou la [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 ou la [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 ou la [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
Les sections suivantes expliquent comment obtenir, répertorier, mettre à jour et supprimer des tâches d’importation. Pour plus d’informations sur la création d’une tâche d’importation, veuillez consulter [Opérations d’API AWS IoT Core pour Amazon Sidewalk pour la mise en service groupée](#iot-sidewalk-apis-provisioning).
## Obtenez des informations sur votre tâche d’importation
Vous pouvez utiliser l’opération d’API [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) pour récupérer des informations sur une tâche d’importation particulière et sur le statut d’intégration des appareils participant à cette tâche. En entrée de l’opération d’API, spécifiez l’ID de tâche d’importation que vous avez obtenu à partir de `StartWirelessDeviceImportTask` ou des opérations d’API `StartSingleWirelessDeviceImportTask`. L’API renverra ensuite des informations sur la tâche d’importation correspondant à l’identifiant spécifié.
Ce qui suit présente un exemple de commande CLI.
```
aws iotwireless list-devices-for-wireless-device-import-task --id e2a5995e-743b-41f2-a1e4-3ca6a5c5249f
```
L’exécution de cette commande renvoie les informations relatives à votre tâche d’importation et l’état d’intégration de l’appareil.
```
{
"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"
},
}
]
}
```
## Obtenir le résumé de l’appareil de la tâche d’importation
Pour obtenir un compte des informations récapitulatives sur l’état d’intégration des appareils que vous avez ajoutés à une tâche d’importation donnée, utilisez l’opération d’API [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). Ce qui suit présente un exemple de commande CLI.
```
aws iotwireless get-wireless-device-import-task --Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f"
```
Le code suivant montre un exemple de réponse de la commande.
```
{
"NumberOfFailedImportedDevices": 2,
"NumberOfOnboardedImportedDevices": 4,
"NumberOfPendingImportedDevices": 1
}
```
## Ajouter des appareils à la tâche d’importation
Utilisez l’opération d’API `UpdateWirelessDeviceImportTask` pour ajouter des appareils à une tâche d’importation existante que vous avez ajoutée. Vous pouvez utiliser cette opération d’API pour ajouter les numéros de série (SMSN) des appareils qui n’étaient pas précédemment inclus dans la tâche que vous avez créée à l’aide de l’opération d’API `StartWirelessDeviceImportTask`.
Pour ajouter des appareils à la tâche d’importation, dans le cadre de la demande d’API, spécifiez un nouveau fichier CSV dans un compartiment Amazon S3 contenant les numéros de série des appareils à ajouter. La demande ne sera acceptée que si le processus d’intégration n’a pas encore commencé pour les appareils actuellement concernés par la tâche d’importation. Si le processus d’intégration a déjà commencé, la demande d’API `UpdateWirelessDeviceImportTask` échouera.
Si vous souhaitez toujours ajouter des appareils à la tâche d’importation, vous pouvez effectuer l’opération d’API `UpdateWirelessDeviceImportTask` une deuxième fois. Avant d’effectuer cette opération d’API, la première demande d’API `UpdateWirelessDeviceImportTask` doit avoir terminé le traitement du fichier CSV dans le compartiment S3.
**Note**
Lorsque vous effectuez une demande d’API `ListImportedWirelessDeviceTasks`, l’URL S3 du nouveau fichier CSV spécifié à l’aide de l’opération d’API `UpdateWirelessDeviceImportTask` n’est actuellement pas renvoyée. Au lieu de cela, l’opération d’API renvoie l’URL S3 de la demande envoyée initialement à l’aide de la demande d’API `StartWirelessDeviceImportTask`.
Ce qui suit présente un exemple de commande CLI.
```
aws iotwireless update-wireless-device-import task \
--Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f" \
--sidewalk '{"FileForCreateDevices": "s3://import_task_bucket/import_file3"}'
```
## Répertoriez les tâches d’importation dans votre Compte AWS
Utilisez l’API `ListWirelessDeviceImportTasks` ou la commande CLI `list-imported-wireless-device-tasks` pour répertorier les tâches d’importation dans votre Compte AWS. Ce qui suit présente un exemple de commande CLI.
```
aws iotwireless list-wireless-device-import-tasks
```
L’exécution de cette commande renvoie une liste de tâches d’importation que vous avez créées. La liste inclut leurs fichiers CSV Amazon S3 et le rôle IAM spécifié, l’ID de la tâche d’importation et des informations récapitulatives sur l’état d’intégration de l’appareil.
```
{
"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"
}
]
}
```
## Supprimer les tâches d’importation de votre Compte AWS
Pour supprimer une tâche d’importation, transmettez l’ID de la tâche d’importation à l’opération d’API `DeleteWirelessDeviceImportTask` ou à la commande CLI `delete-wireless-device-import-task`.
**Avertissement**
Les actions de suppression ne peuvent pas être annulées. La tâche d’importation sera définitivement supprimée de votre Compte AWS.
Lorsque vous effectuez la demande d’API `DeleteWirelessDeviceImportTask`, un processus en arrière-plan commence à supprimer la tâche d’importation. Lorsque la demande est en cours, les numéros de série (SMSN) des appareils concernés par les tâches d’importation sont en cours de suppression. Ce n’est qu’une fois la suppression terminée que vous pourrez voir ces informations à l’aide de `ListImportedWirelessDeviceTasks` ou des opérations d’API `GetImportedWirelessDeviceTasks`.
Si une tâche d’importation contient toujours des appareils en attente d’intégration, la demande d’API `DeleteWirelessDeviceImportTask` ne sera traitée qu’une fois que tous les appareils concernés par la tâche d’importation auront été intégrés ou n’auront pas été intégrés. Une tâche d’importation expire au bout de 90 jours, et une fois la tâche expirée, elle peut être supprimée de votre compte. Toutefois, les appareils qui ont été intégrés avec succès à l’aide de la tâche d’importation ne seront pas supprimés.
**Note**
Si vous tentez de créer une autre tâche d’importation incluant le numéro de série d’un appareil en attente de suppression à l’aide de la demande d’API `DeleteWirelessDeviceImportTask`, l’opération d’API `StartWirelessDeviceImportTask` renverra une erreur.
Ce qui suit présente un exemple de commande CLI.
```
aws iotwireless delete-import-task --Id "e2a5995e-743b-41f2-a1e4-3ca6a5c5249f"
```
Cette commande ne produit aucune sortie. Une fois la tâche supprimée, pour vérifier que la tâche d’importation a été supprimée de votre compte, vous pouvez utiliser l’opération d’API `GetWirelessDeviceImportTask` ou l’opération d’API `ListWirelessDeviceImportTasks`.