HealthLake / Client / describe_fhir_import_job

describe_fhir_import_job#

HealthLake.Client.describe_fhir_import_job(**kwargs)#

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

Request Syntax

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

Parameters:

DatastoreId (string) –
[REQUIRED]

The AWS-generated ID of the data store.
JobId (string) –
[REQUIRED]

The AWS-generated job ID.

Return type:

dict

Returns:

Response Syntax

{
    'ImportJobProperties': {
        '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',
        'InputDataConfig': {
            'S3Uri': 'string'
        },
        'JobOutputDataConfig': {
            'S3Configuration': {
                'S3Uri': 'string',
                'KmsKeyId': 'string'
            }
        },
        'JobProgressReport': {
            'TotalNumberOfScannedFiles': 123,
            'TotalSizeOfScannedFilesInMB': 123.0,
            'TotalNumberOfImportedFiles': 123,
            'TotalNumberOfResourcesScanned': 123,
            'TotalNumberOfResourcesImported': 123,
            'TotalNumberOfResourcesWithCustomerError': 123,
            'TotalNumberOfFilesReadWithCustomerError': 123,
            'Throughput': 123.0
        },
        'DataAccessRoleArn': 'string',
        'Message': 'string'
    }
}

Response Structure

(dict) –
- ImportJobProperties (dict) –
  
  The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.
  - JobId (string) –
    
    The AWS-generated id number for the Import job.
  - JobName (string) –
    
    The user-generated name for an Import job.
  - JobStatus (string) –
    
    The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
  - SubmitTime (datetime) –
    
    The time that the Import job was submitted for processing.
  - EndTime (datetime) –
    
    The time that the Import job was completed.
  - DatastoreId (string) –
    
    The datastore id used when the Import job was created.
  - InputDataConfig (dict) –
    
    The input data configuration that was supplied when the Import job was created.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: S3Uri. 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'}
    - S3Uri (string) –
      
      The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
  - JobOutputDataConfig (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.
  - JobProgressReport (dict) –
    
    Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.
    - TotalNumberOfScannedFiles (integer) –
      
      The number of files scanned from input S3 bucket.
    - TotalSizeOfScannedFilesInMB (float) –
      
      The size (in MB) of the files scanned from the input S3 bucket.
    - TotalNumberOfImportedFiles (integer) –
      
      The number of files imported so far.
    - TotalNumberOfResourcesScanned (integer) –
      
      The number of resources scanned from the input S3 bucket.
    - TotalNumberOfResourcesImported (integer) –
      
      The number of resources imported so far.
    - TotalNumberOfResourcesWithCustomerError (integer) –
      
      The number of resources that failed due to customer error.
    - TotalNumberOfFilesReadWithCustomerError (integer) –
      
      The number of files that failed to be read from the input S3 bucket due to customer error.
    - Throughput (float) –
      
      The throughput (in MB/sec) of the import job.
  - DataAccessRoleArn (string) –
    
    The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.
  - Message (string) –
    
    An explanation of any errors that may have occurred during the FHIR import job.