Skip to content

list_discovered_devices

list_discovered_devices(
    identifier: DeviceDiscoveryId,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDiscoveredDevicesResponse

Lists all devices discovered during a specific device discovery task.

Parameters:

  • identifier (DeviceDiscoveryId) –

    The identifier of the device discovery job to list discovered devices for.

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

    A token used for pagination of results.

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

    The maximum number of discovered devices to return in a single response.

Raises:

Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def list_discovered_devices(
    self,
    identifier: "capo_iot_managed_integrations.types.device_discovery_id.DeviceDiscoveryId",
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    next_token: Optional[
        "capo_iot_managed_integrations.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_iot_managed_integrations.types.max_results.MaxResults"
    ] = None,
) -> "capo_iot_managed_integrations.types.list_discovered_devices_response.ListDiscoveredDevicesResponse":
    """<p>Lists all devices discovered during a specific device discovery task.</p>

    Args:
        identifier: <p>The identifier of the device discovery job to list discovered devices for.</p>
        next_token: <p>A token used for pagination of results.</p>
        max_results: <p>The maximum number of discovered devices to return in a single response.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot_managed_integrations.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.list_discovered_devices_request.ListDiscoveredDevicesRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.list_discovered_devices_response.ListDiscoveredDevicesResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.list_discovered_devices

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.list_discovered_devices.list_discovered_devices(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_iot_managed_integrations.types.list_discovered_devices_response.ListDiscoveredDevicesResponse",
    ) -> dict[str, Any]:
        import capo_iot_managed_integrations.types.list_discovered_devices_response

        return capo_iot_managed_integrations.types.list_discovered_devices_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListDiscoveredDevices", redact_output=_redact_output),
    )
    input_: capo_iot_managed_integrations.types.list_discovered_devices_request.ListDiscoveredDevicesRequest = {
        "identifier": identifier
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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