HealthLake / Client / describe_fhir_export_job

describe_fhir_export_job

HealthLake.Client.describe_fhir_export_job(**kwargs)

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

See also: AWS API Documentation

Request Syntax

response = client.describe_fhir_export_job(
    DatastoreId='string',
    JobId='string'
)

Parameters:

• DatastoreId (string) –

  [REQUIRED]

  The AWS generated ID for the data store from which files are being exported from for an export job.

• JobId (string) –

  [REQUIRED]

  The AWS generated ID for an export job.

Return type:

dict

Returns:

Response Syntax

{
    'ExportJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'DatastoreId': 'string',
        'OutputDataConfig': {
            'S3Configuration': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            }
        },
        'DataAccessRoleArn': 'string',
        'Message': 'string'
    }
}

Response Structure

• (dict) –

  • ExportJobProperties (dict) –

    Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.

    • JobId (string) –

      The AWS generated ID for an export job.

    • JobName (string) –

      The user generated name for an export job.

    • JobStatus (string) –

      The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.

    • SubmitTime (datetime) –

      The time an export job was initiated.

    • EndTime (datetime) –

      The time an export job completed.

    • DatastoreId (string) –

      The AWS generated ID for the data store from which files are being exported for an export job.

    • OutputDataConfig (dict) –

      The output data configuration that was supplied when the export job was created.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: S3Configuration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • S3Configuration (dict) –

        The output data configuration that was supplied when the export job was created.

        • S3Uri (string) –

          The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.

        • KmsKeyId (string) –

          The KMS key ID used to access the S3 bucket.

    • DataAccessRoleArn (string) –

      The Amazon Resource Name used during the initiation of the job.

    • Message (string) –

      An explanation of any errors that may have occurred during the export job.

Exceptions

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.InternalServerException