IoTWireless / Client / list_wireless_devices

list_wireless_devices#

IoTWireless.Client.list_wireless_devices(**kwargs)#

Lists the wireless devices registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_wireless_devices(
    MaxResults=123,
    NextToken='string',
    DestinationName='string',
    DeviceProfileId='string',
    ServiceProfileId='string',
    WirelessDeviceType='Sidewalk'|'LoRaWAN',
    FuotaTaskId='string',
    MulticastGroupId='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; otherwise null to receive the first set of results.

  • DestinationName (string) – A filter to list only the wireless devices that use this destination.

  • DeviceProfileId (string) – A filter to list only the wireless devices that use this device profile.

  • ServiceProfileId (string) – A filter to list only the wireless devices that use this service profile.

  • WirelessDeviceType (string) – A filter to list only the wireless devices that use this wireless device type.

  • FuotaTaskId (string) – The ID of a FUOTA task.

  • MulticastGroupId (string) – The ID of the multicast group.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'WirelessDeviceList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Type': 'Sidewalk'|'LoRaWAN',
            'Name': 'string',
            'DestinationName': 'string',
            'LastUplinkReceivedAt': 'string',
            'LoRaWAN': {
                'DevEui': 'string'
            },
            'Sidewalk': {
                'AmazonId': 'string',
                'SidewalkId': 'string',
                'SidewalkManufacturingSn': 'string',
                'DeviceCertificates': [
                    {
                        'SigningAlg': 'Ed25519'|'P256r1',
                        'Value': 'string'
                    },
                ],
                'DeviceProfileId': 'string',
                'Status': 'PROVISIONED'|'REGISTERED'|'ACTIVATED'|'UNKNOWN'
            },
            'FuotaDeviceStatus': 'Initial'|'Package_Not_Supported'|'FragAlgo_unsupported'|'Not_enough_memory'|'FragIndex_unsupported'|'Wrong_descriptor'|'SessionCnt_replay'|'MissingFrag'|'MemoryError'|'MICError'|'Successful'|'Device_exist_in_conflict_fuota_task',
            'MulticastDeviceStatus': 'string',
            'McGroupId': 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.

    • WirelessDeviceList (list) –

      The ID of the wireless device.

      • (dict) –

        Information about a wireless device’s operation.

        • Arn (string) –

          The Amazon Resource Name of the resource.

        • Id (string) –

          The ID of the wireless device reporting the data.

        • Type (string) –

          The wireless device type.

        • Name (string) –

          The name of the resource.

        • DestinationName (string) –

          The name of the destination to which the device is assigned.

        • LastUplinkReceivedAt (string) –

          The date and time when the most recent uplink was received.

          Note

          Theis value is only valid for 3 months.

        • LoRaWAN (dict) –

          LoRaWAN device info.

          • DevEui (string) –

            The DevEUI value.

        • Sidewalk (dict) –

          The Sidewalk account credentials.

          • AmazonId (string) –

            The Sidewalk Amazon ID.

          • SidewalkId (string) –

            The sidewalk device identification.

          • SidewalkManufacturingSn (string) –

            The Sidewalk manufacturing series number.

          • DeviceCertificates (list) –

            The sidewalk device certificates for Ed25519 and P256r1.

            • (dict) –

              List of sidewalk certificates.

              • SigningAlg (string) –

                The certificate chain algorithm provided by sidewalk.

              • Value (string) –

                The value of the chosen sidewalk certificate.

          • DeviceProfileId (string) –

            Sidewalk object used by list functions.

          • Status (string) –

            The status of the Sidewalk devices, such as provisioned or registered.

        • FuotaDeviceStatus (string) –

          The status of a wireless device in a FUOTA task.

        • MulticastDeviceStatus (string) –

          The status of the wireless device in the multicast group.

        • McGroupId (integer) –

          Id of the multicast group.

Exceptions