AWS API Changes

2024/02/15 - Amazon HealthLake - 2 updated api methods

Changes This release adds a new response parameter, JobProgressReport, to the DescribeFHIRImportJob and ListFHIRImportJobs API operation. JobProgressReport provides details on the progress of the import job on the server.

DescribeFHIRImportJob (updated)

Link ¶
Changes (response)

{'ImportJobProperties': {'JobProgressReport': {'Throughput': 'double',
                                               'TotalNumberOfFilesReadWithCustomerError': 'long',
                                               'TotalNumberOfImportedFiles': 'long',
                                               'TotalNumberOfResourcesImported': 'long',
                                               'TotalNumberOfResourcesScanned': 'long',
                                               'TotalNumberOfResourcesWithCustomerError': 'long',
                                               'TotalNumberOfScannedFiles': 'long',
                                               'TotalSizeOfScannedFilesInMB': 'double'}}}

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

See also: AWS API Documentation

Request Syntax

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

type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The AWS-generated ID of the data store.

type JobId:

string

param JobId:

[REQUIRED]

The AWS-generated job ID.

rtype:

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.

ListFHIRImportJobs (updated)

Link ¶
Changes (response)

{'ImportJobPropertiesList': {'JobProgressReport': {'Throughput': 'double',
                                                   'TotalNumberOfFilesReadWithCustomerError': 'long',
                                                   'TotalNumberOfImportedFiles': 'long',
                                                   'TotalNumberOfResourcesImported': 'long',
                                                   'TotalNumberOfResourcesScanned': 'long',
                                                   'TotalNumberOfResourcesWithCustomerError': 'long',
                                                   'TotalNumberOfScannedFiles': 'long',
                                                   'TotalSizeOfScannedFilesInMB': 'double'}}}

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

See also: AWS API Documentation

Request Syntax

client.list_fhir_import_jobs(
    DatastoreId='string',
    NextToken='string',
    MaxResults=123,
    JobName='string',
    JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
    SubmittedBefore=datetime(2015, 1, 1),
    SubmittedAfter=datetime(2015, 1, 1)
)

type DatastoreId:

string

param DatastoreId:

[REQUIRED]

This parameter limits the response to the import job with the specified data store ID.

type NextToken:

string

param NextToken:

A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.

type MaxResults:

integer

param MaxResults:

This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.

type JobName:

string

param JobName:

This parameter limits the response to the import job with the specified job name.

type JobStatus:

string

param JobStatus:

This parameter limits the response to the import job with the specified job status.

type SubmittedBefore:

datetime

param SubmittedBefore:

This parameter limits the response to FHIR import jobs submitted before a user specified date.

type SubmittedAfter:

datetime

param SubmittedAfter:

This parameter limits the response to FHIR import jobs submitted after a user specified date.

rtype:

dict

returns:

Response Syntax

{
    'ImportJobPropertiesList': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ImportJobPropertiesList (list) --
  
  The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.
  - (dict) --
    
    Displays the properties of the import job, including the ID, Arn, Name, the 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.
- NextToken (string) --
  
  A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.