Skip to content

list_wireless_devices

list_wireless_devices(
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    destination_name: Optional[DestinationName] = None,
    device_profile_id: Optional[DeviceProfileId] = None,
    service_profile_id: Optional[ServiceProfileId] = None,
    wireless_device_type: Optional[WirelessDeviceType] = None,
    fuota_task_id: Optional[FuotaTaskId] = None,
    multicast_group_id: Optional[MulticastGroupId] = None,
) -> ListWirelessDevicesResponse

Lists the wireless devices registered to your AWS account.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in this operation.

  • next_token (Optional[NextToken], default: None ) –

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

  • destination_name (Optional[DestinationName], default: None ) –

    A filter to list only the wireless devices that use as uplink destination.

  • device_profile_id (Optional[DeviceProfileId], default: None ) –

    A filter to list only the wireless devices that use this device profile.

  • service_profile_id (Optional[ServiceProfileId], default: None ) –

    A filter to list only the wireless devices that use this service profile.

  • wireless_device_type (Optional[WirelessDeviceType], default: None ) –

    A filter to list only the wireless devices that use this wireless device type.

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def list_wireless_devices(
    self,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    max_results: Optional["capo_iot_wireless.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iot_wireless.types.next_token.NextToken"] = None,
    destination_name: Optional[
        "capo_iot_wireless.types.destination_name.DestinationName"
    ] = None,
    device_profile_id: Optional[
        "capo_iot_wireless.types.device_profile_id.DeviceProfileId"
    ] = None,
    service_profile_id: Optional[
        "capo_iot_wireless.types.service_profile_id.ServiceProfileId"
    ] = None,
    wireless_device_type: Optional[
        "capo_iot_wireless.types.wireless_device_type.WirelessDeviceType"
    ] = None,
    fuota_task_id: Optional[
        "capo_iot_wireless.types.fuota_task_id.FuotaTaskId"
    ] = None,
    multicast_group_id: Optional[
        "capo_iot_wireless.types.multicast_group_id.MulticastGroupId"
    ] = None,
) -> "capo_iot_wireless.types.list_wireless_devices_response.ListWirelessDevicesResponse":
    """<p>Lists the wireless devices registered to your AWS account.</p>

    Args:
        max_results: <p>The maximum number of results to return in this operation.</p>
        next_token: <p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>
        destination_name: <p>A filter to list only the wireless devices that use as uplink destination.</p>
        device_profile_id: <p>A filter to list only the wireless devices that use this device profile.</p>
        service_profile_id: <p>A filter to list only the wireless devices that use this service profile.</p>
        wireless_device_type: <p>A filter to list only the wireless devices that use this wireless device type.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.list_wireless_devices_request.ListWirelessDevicesRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.list_wireless_devices_response.ListWirelessDevicesResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.list_wireless_devices

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.list_wireless_devices.list_wireless_devices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWirelessDevices")
    )
    input_: capo_iot_wireless.types.list_wireless_devices_request.ListWirelessDevicesRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if destination_name is not None:
        input_["destination_name"] = destination_name
    if device_profile_id is not None:
        input_["device_profile_id"] = device_profile_id
    if service_profile_id is not None:
        input_["service_profile_id"] = service_profile_id
    if wireless_device_type is not None:
        input_["wireless_device_type"] = wireless_device_type
    if fuota_task_id is not None:
        input_["fuota_task_id"] = fuota_task_id
    if multicast_group_id is not None:
        input_["multicast_group_id"] = multicast_group_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output