list_devices_jobs `async` ¶

list_devices_jobs(
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    device_id: Optional[DeviceId] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxSize25] = None,
) -> ListDevicesJobsResponse

Returns a list of jobs.

Parameters:

device_id (Optional[DeviceId], default: None ) –

Filter results by the job's target device ID.
next_token (Optional[NextToken], default: None ) –

Specify the pagination token from a previous request to retrieve the next page of results.
max_results (Optional[MaxSize25], default: None ) –

The maximum number of device jobs to return in one page of results.

Raises:

AccessDeniedException –

The requestor does not have permission to access the target action or resource.
ConflictException –

The target resource is in use.
InternalServerException –

An internal error occurred.
ResourceNotFoundException –

The target resource was not found.
ValidationException –

The request contains an invalid parameter value.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_panorama/_services/async_panorama.py

async def list_devices_jobs(
    self,
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    device_id: Optional["capo_panorama.types.device_id.DeviceId"] = None,
    next_token: Optional["capo_panorama.types.next_token.NextToken"] = None,
    max_results: Optional["capo_panorama.types.max_size25.MaxSize25"] = None,
) -> "capo_panorama.types.list_devices_jobs_response.ListDevicesJobsResponse":
    """<p>Returns a list of jobs.</p>

    Args:
        device_id: <p>Filter results by the job's target device ID.</p>
        next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
        max_results: <p>The maximum number of device jobs to return in one page of results.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_panorama.types.list_devices_jobs_request.ListDevicesJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_panorama.types.list_devices_jobs_response.ListDevicesJobsResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.list_devices_jobs

        (
            output,
            http_response,
        ) = await capo_panorama._operations.omni_cloud_service_lambda.list_devices_jobs.async_list_devices_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDevicesJobs")
    )
    input_: capo_panorama.types.list_devices_jobs_request.ListDevicesJobsRequest = {}
    if device_id is not None:
        input_["device_id"] = device_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_devices_jobs async ¶

list_devices_jobs `async` ¶