IoTWireless / Client / list_devices_for_wireless_device_import_task

list_devices_for_wireless_device_import_task#

IoTWireless.Client.list_devices_for_wireless_device_import_task(**kwargs)#

List the Sidewalk devices in an import task and their onboarding status.

See also: AWS API Documentation

Request Syntax

response = client.list_devices_for_wireless_device_import_task(
    Id='string',
    MaxResults=123,
    NextToken='string',
    Status='INITIALIZED'|'PENDING'|'ONBOARDED'|'FAILED'
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The identifier of the import task for which wireless devices are listed.

  • 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; otherwise null to receive the first set of results.

  • Status (string) – The status of the devices in the import task.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DestinationName': 'string',
    'ImportedWirelessDeviceList': [
        {
            'Sidewalk': {
                'SidewalkManufacturingSn': 'string',
                'OnboardingStatus': 'INITIALIZED'|'PENDING'|'ONBOARDED'|'FAILED',
                'OnboardingStatusReason': 'string',
                'LastUpdateTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The token to use to get the next set of results, or null if there are no additional results.

    • DestinationName (string) –

      The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

    • ImportedWirelessDeviceList (list) –

      List of wireless devices in an import task and their onboarding status.

      • (dict) –

        Information about a wireless device that has been added to an import task.

        • Sidewalk (dict) –

          The Sidewalk-related information about a device that has been added to an import task.

          • SidewalkManufacturingSn (string) –

            The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.

          • OnboardingStatus (string) –

            The onboarding status of the Sidewalk device in the import task.

          • OnboardingStatusReason (string) –

            The reason for the onboarding status information for the Sidewalk device.

          • LastUpdateTime (datetime) –

            The time at which the status information was last updated.

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