Skip to content

list_device_discoveries

list_device_discoveries(
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    type_filter: Optional[DiscoveryType] = None,
    status_filter: Optional[DeviceDiscoveryStatus] = None,
) -> ListDeviceDiscoveriesResponse

Lists all device discovery tasks, with optional filtering by type and status.

Parameters:

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

    A token used for pagination of results.

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

    The maximum number of device discovery jobs to return in a single response.

  • type_filter (Optional[DiscoveryType], default: None ) –

    The discovery type to filter device discovery jobs by.

  • status_filter (Optional[DeviceDiscoveryStatus], default: None ) –

    The status to filter device discovery jobs by.

Raises:

Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def list_device_discoveries(
    self,
    *,
    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,
    type_filter: Optional[
        "capo_iot_managed_integrations.types.discovery_type.DiscoveryType"
    ] = None,
    status_filter: Optional[
        "capo_iot_managed_integrations.types.device_discovery_status.DeviceDiscoveryStatus"
    ] = None,
) -> "capo_iot_managed_integrations.types.list_device_discoveries_response.ListDeviceDiscoveriesResponse":
    """<p>Lists all device discovery tasks, with optional filtering by type and status.</p>

    Args:
        next_token: <p>A token used for pagination of results.</p>
        max_results: <p>The maximum number of device discovery jobs to return in a single response.</p>
        type_filter: <p>The discovery type to filter device discovery jobs by.</p>
        status_filter: <p>The status to filter device discovery jobs by.</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.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_device_discoveries_request.ListDeviceDiscoveriesRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.list_device_discoveries_response.ListDeviceDiscoveriesResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.list_device_discoveries

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDeviceDiscoveries")
    )
    input_: capo_iot_managed_integrations.types.list_device_discoveries_request.ListDeviceDiscoveriesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if type_filter is not None:
        input_["type_filter"] = type_filter
    if status_filter is not None:
        input_["status_filter"] = status_filter

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