Skip to content

describe_fhir_export_job async

describe_fhir_export_job(
    datastore_id: DatastoreId,
    job_id: JobId,
    *,
    config_overrides: Optional[AsyncHealthLakeClientConfig] = None,
) -> DescribeFHIRExportJobResponse

Get FHIR export job properties.

Parameters:

  • datastore_id (DatastoreId) –

    The data store identifier from which FHIR data is being exported from.

  • job_id (JobId) –

    The export job identifier.

Raises:

Source code in docs_src/capo_healthlake/_services/async_health_lake.py
async def describe_fhir_export_job(
    self,
    datastore_id: "capo_healthlake.types.datastore_id.DatastoreId",
    job_id: "capo_healthlake.types.job_id.JobId",
    *,
    config_overrides: Optional[AsyncHealthLakeClientConfig] = None,
) -> "capo_healthlake.types.describe_fhir_export_job_response.DescribeFHIRExportJobResponse":
    """<p>Get FHIR export job properties.</p>

    Args:
        datastore_id: <p>The data store identifier from which FHIR data is being exported from.</p>
        job_id: <p>The export job identifier.</p>

    Raises:
        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.describe_fhir_export_job_request.DescribeFHIRExportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_healthlake.types.describe_fhir_export_job_response.DescribeFHIRExportJobResponse"
    ]:
        import capo_healthlake._operations.health_lake.describe_fhir_export_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFHIRExportJob")
    )
    input_: capo_healthlake.types.describe_fhir_export_job_request.DescribeFHIRExportJobRequest = {
        "datastore_id": datastore_id,
        "job_id": job_id,
    }

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