IoTWireless / Client / list_wireless_device_import_tasks
list_wireless_device_import_tasks#
- IoTWireless.Client.list_wireless_device_import_tasks(**kwargs)#
List wireless devices that have been added to an import task.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_device_import_tasks( MaxResults=123, NextToken='string' )
- Parameters:
MaxResults (integer) – The maximum number of results to return in this operation.
NextToken (string) – To retrieve the next set of results, the
nextToken
value from a previous response; otherwisenull
to receive the first set of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'NextToken': 'string', 'WirelessDeviceImportTaskList': [ { 'Id': 'string', 'Arn': 'string', 'DestinationName': 'string', 'Sidewalk': { 'DeviceCreationFileList': [ 'string', ], 'Role': 'string' }, 'CreationTime': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'INITIALIZED'|'PENDING'|'COMPLETE'|'FAILED'|'DELETING', 'StatusReason': 'string', 'InitializedImportedDeviceCount': 123, 'PendingImportedDeviceCount': 123, 'OnboardedImportedDeviceCount': 123, 'FailedImportedDeviceCount': 123 }, ] }
Response Structure
(dict) –
NextToken (string) –
The token to use to get the next set of results, or
null
if there are no additional results.WirelessDeviceImportTaskList (list) –
List of import tasks and summary information of onboarding status of devices in each import task.
(dict) –
Information about an import task for wireless devices.
Id (string) –
The ID of the wireless device import task.
Arn (string) –
The ARN (Amazon Resource Name) of the wireless device import task.
DestinationName (string) –
The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless
Sidewalk (dict) –
The Sidewalk-related information of the wireless device import task.
DeviceCreationFileList (list) –
List of Sidewalk devices that are added to the import task.
(string) –
Role (string) –
The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.
CreationTime (datetime) –
The time at which the import task was created.
Status (string) –
The status information of the wireless device import task.
StatusReason (string) –
The reason that provides additional information about the import task status.
InitializedImportedDeviceCount (integer) –
The summary information of count of wireless devices that are waiting for the control log to be added to an import task.
PendingImportedDeviceCount (integer) –
The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.
OnboardedImportedDeviceCount (integer) –
The summary information of count of wireless devices in an import task that have been onboarded to the import task.
FailedImportedDeviceCount (integer) –
The summary information of count of wireless devices in an import task that failed to onboarded to the import task.
Exceptions
IoTWireless.Client.exceptions.ValidationException
IoTWireless.Client.exceptions.AccessDeniedException
IoTWireless.Client.exceptions.ResourceNotFoundException
IoTWireless.Client.exceptions.InternalServerException
IoTWireless.Client.exceptions.ConflictException
IoTWireless.Client.exceptions.ThrottlingException