Skip to content

list_dicom_import_jobs async

list_dicom_import_jobs(
    datastore_id: DatastoreId,
    *,
    config_overrides: Optional[AsyncMedicalImagingClientConfig] = None,
    job_status: Optional[JobStatus] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[int] = None,
) -> ListDICOMImportJobsResponse

List import jobs created for a specific data store.

Parameters:

  • datastore_id (DatastoreId) –

    The data store identifier.

  • job_status (Optional[JobStatus], default: None ) –

    The filters for listing import jobs based on status.

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

    The pagination token used to request the list of import jobs on the next page.

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

    The max results count. The upper bound is determined by load testing.

Raises:

Source code in docs_src/capo_medical_imaging/_services/async_medical_imaging.py
async def list_dicom_import_jobs(
    self,
    datastore_id: "capo_medical_imaging.types.datastore_id.DatastoreId",
    *,
    config_overrides: Optional[AsyncMedicalImagingClientConfig] = None,
    job_status: Optional["capo_medical_imaging.types.job_status.JobStatus"] = None,
    next_token: Optional["capo_medical_imaging.types.next_token.NextToken"] = None,
    max_results: Optional[int] = None,
) -> "capo_medical_imaging.types.list_dicom_import_jobs_response.ListDICOMImportJobsResponse":
    """<p>List import jobs created for a specific data store.</p>

    Args:
        datastore_id: <p>The data store identifier.</p>
        job_status: <p>The filters for listing import jobs based on status.</p>
        next_token: <p>The pagination token used to request the list of import jobs on the next page.</p>
        max_results: <p>The max results count. The upper bound is determined by load testing.</p>

    Raises:
        capo_medical_imaging.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_medical_imaging.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_medical_imaging.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during processing of the request.</p>
        capo_medical_imaging.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource which does not exist.</p>
        capo_medical_imaging.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling.</p>
        capo_medical_imaging.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the service.</p>
        capo_medical_imaging.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_medical_imaging.types.list_dicom_import_jobs_request.ListDICOMImportJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_medical_imaging.types.list_dicom_import_jobs_response.ListDICOMImportJobsResponse"
    ]:
        import capo_medical_imaging._operations.ahi_gateway_service.list_dicom_import_jobs

        (
            output,
            http_response,
        ) = await capo_medical_imaging._operations.ahi_gateway_service.list_dicom_import_jobs.async_list_dicom_import_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDICOMImportJobs")
    )
    input_: capo_medical_imaging.types.list_dicom_import_jobs_request.ListDICOMImportJobsRequest = {
        "datastore_id": datastore_id
    }
    if job_status is not None:
        input_["job_status"] = job_status
    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