Skip to content

list_fhir_import_jobs async

list_fhir_import_jobs(
    datastore_id: DatastoreId,
    *,
    config_overrides: Optional[AsyncHealthLakeClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsInteger] = None,
    job_name: Optional[JobName] = None,
    job_status: Optional[JobStatus] = None,
    submitted_before: Optional[HealthLakeTimestamp] = None,
    submitted_after: Optional[HealthLakeTimestamp] = None,
) -> ListFHIRImportJobsResponse

List all FHIR import jobs associated with an account and their statuses.

Parameters:

  • datastore_id (DatastoreId) –

    Limits the response to the import job with the specified data store ID.

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

    The pagination token used to identify the next page of results to return.

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

    Limits the number of results returned for ListFHIRImportJobs to a maximum quantity specified by the user.

  • job_name (Optional[JobName], default: None ) –

    Limits the response to the import job with the specified job name.

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

    Limits the response to the import job with the specified job status.

  • submitted_before (Optional[HealthLakeTimestamp], default: None ) –

    Limits the response to FHIR import jobs submitted before a user- specified date.

  • submitted_after (Optional[HealthLakeTimestamp], default: None ) –

    Limits the response to FHIR import jobs submitted after a user-specified date.

Raises:

Source code in docs_src/capo_healthlake/_services/async_health_lake.py
async def list_fhir_import_jobs(
    self,
    datastore_id: "capo_healthlake.types.datastore_id.DatastoreId",
    *,
    config_overrides: Optional[AsyncHealthLakeClientConfig] = None,
    next_token: Optional["capo_healthlake.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_healthlake.types.max_results_integer.MaxResultsInteger"
    ] = None,
    job_name: Optional["capo_healthlake.types.job_name.JobName"] = None,
    job_status: Optional["capo_healthlake.types.job_status.JobStatus"] = None,
    submitted_before: Optional[
        "capo_healthlake.types.health_lake_timestamp.HealthLakeTimestamp"
    ] = None,
    submitted_after: Optional[
        "capo_healthlake.types.health_lake_timestamp.HealthLakeTimestamp"
    ] = None,
) -> "capo_healthlake.types.list_fhir_import_jobs_response.ListFHIRImportJobsResponse":
    """<p>List all FHIR import jobs associated with an account and their statuses.</p>

    Args:
        datastore_id: <p>Limits the response to the import job with the specified data store ID. </p>
        next_token: <p>The pagination token used to identify the next page of results to return.</p>
        max_results: <p>Limits the number of results returned for <code>ListFHIRImportJobs</code> to a maximum quantity specified by the user.</p>
        job_name: <p>Limits the response to the import job with the specified job name. </p>
        job_status: <p>Limits the response to the import job with the specified job status. </p>
        submitted_before: <p>Limits the response to FHIR import jobs submitted before a user- specified date. </p>
        submitted_after: <p>Limits the response to FHIR import jobs submitted after a user-specified date.</p>

    Raises:
        capo_healthlake.errors.access_denied_exception.AccessDeniedException: <p>Access is denied. Your account is not authorized to perform this operation.</p>
        capo_healthlake.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred in the service.</p>
        capo_healthlake.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested data store was not found.</p>
        capo_healthlake.errors.throttling_exception.ThrottlingException: <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
        capo_healthlake.errors.validation_exception.ValidationException: <p>The user input parameter was invalid.</p>
        capo_healthlake.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_healthlake.types.list_fhir_import_jobs_request.ListFHIRImportJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_healthlake.types.list_fhir_import_jobs_response.ListFHIRImportJobsResponse"
    ]:
        import capo_healthlake._operations.health_lake.list_fhir_import_jobs

        (
            output,
            http_response,
        ) = await capo_healthlake._operations.health_lake.list_fhir_import_jobs.async_list_fhir_import_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFHIRImportJobs")
    )
    input_: capo_healthlake.types.list_fhir_import_jobs_request.ListFHIRImportJobsRequest = {
        "datastore_id": datastore_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if job_name is not None:
        input_["job_name"] = job_name
    if job_status is not None:
        input_["job_status"] = job_status
    if submitted_before is not None:
        input_["submitted_before"] = submitted_before
    if submitted_after is not None:
        input_["submitted_after"] = submitted_after

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