AWS API Changes

2020/12/08 - Amazon HealthLake - 6 new api methods

Changes Update healthlake client to latest version

ListFHIRDatastores (new)

Link ¶

Lists all FHIR datastores that are in the user’s account, regardless of datastore status.

Request Syntax

client.list_fhir_datastores(
    Filter={
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
        'CreatedBefore': datetime(2015, 1, 1),
        'CreatedAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter:

dict

param Filter:

Lists all filters associated with a FHIR datastore request.

DatastoreName (string) --

Allows the user to filter datastore results by name.
DatastoreStatus (string) --

Allows the user to filter datastore results by status.
CreatedBefore (datetime) --

A filter that allows the user to set cutoff dates for records. All datastores created before the specified date will be included in the results.
CreatedAfter (datetime) --

A filter that allows the user to set cutoff dates for records. All datastores created after the specified date will be included in the results.

type NextToken:

string

param NextToken:

Fetches the next page of datastores when results are paginated.

type MaxResults:

integer

param MaxResults:

The maximum number of datastores returned in a single page of a ListFHIRDatastoresRequest call.

rtype:

dict

returns:

Response Syntax

{
    'DatastorePropertiesList': [
        {
            'DatastoreId': 'string',
            'DatastoreArn': 'string',
            'DatastoreName': 'string',
            'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
            'CreatedAt': datetime(2015, 1, 1),
            'DatastoreTypeVersion': 'R4',
            'DatastoreEndpoint': 'string',
            'PreloadDataConfig': {
                'PreloadDataType': 'SYNTHEA'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DatastorePropertiesList (list) --
  
  All properties associated with the listed datastores.
  - (dict) --
    
    Displays the properties of the datastore, including the ID, Arn, name, and the status of the datastore.
    - DatastoreId (string) --
      
      The AWS-generated ID number for the datastore.
    - DatastoreArn (string) --
      
      The Amazon Resource Name used in the creation of the datastore.
    - DatastoreName (string) --
      
      The user-generated name for the datastore.
    - DatastoreStatus (string) --
      
      The status of the datastore. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
    - CreatedAt (datetime) --
      
      The time that a datastore was created.
    - DatastoreTypeVersion (string) --
      
      The FHIR version. Only R4 version data is supported.
    - DatastoreEndpoint (string) --
      
      The AWS endpoint for the datastore. Each datastore will have it's own endpoint with datastore ID in the endpoint URL.
    - PreloadDataConfig (dict) --
      
      The preloaded data configuration for the datastore. Only data preloaded from Synthea is supported.
      - PreloadDataType (string) --
        
        The type of preloaded data. Only Synthea preloaded data is supported.
- NextToken (string) --
  
  Pagination token that can be used to retrieve the next page of results.

StartFHIRImportJob (new)

Link ¶

Begins a FHIR Import job.

See also: AWS API Documentation

Request Syntax

client.start_fhir_import_job(
    JobName='string',
    InputDataConfig={
        'S3Uri': 'string'
    },
    DatastoreId='string',
    DataAccessRoleArn='string',
    ClientToken='string'
)

type JobName:

string

param JobName:

The name of the FHIR Import job in the StartFHIRImport job request.

type InputDataConfig:

dict

param InputDataConfig:

[REQUIRED]

The input properties of the FHIR Import job in the StartFHIRImport job request.

S3Uri (string) --

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

type DatastoreId:

string

param DatastoreId:

[REQUIRED]

The AWS-generated datastore ID.

type DataAccessRoleArn:

string

param DataAccessRoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.

type ClientToken:

string

param ClientToken:

[REQUIRED]

Optional user provided token used for ensuring idempotency.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'DatastoreId': 'string'
}

Response Structure

(dict) --
- JobId (string) --
  
  The AWS-generated job ID.
- JobStatus (string) --
  
  The status of an import job.
- DatastoreId (string) --
  
  The AWS-generated datastore ID.

CreateFHIRDatastore (new)

Link ¶

Creates a datastore that can ingest and export FHIR data.

See also: AWS API Documentation

Request Syntax

client.create_fhir_datastore(
    DatastoreName='string',
    DatastoreTypeVersion='R4',
    PreloadDataConfig={
        'PreloadDataType': 'SYNTHEA'
    },
    ClientToken='string'
)

type DatastoreName:

string

param DatastoreName:

The user generated name for the datastore.

type DatastoreTypeVersion:

string

param DatastoreTypeVersion:

[REQUIRED]

The FHIR version of the datastore. The only supported version is R4.

type PreloadDataConfig:

dict

param PreloadDataConfig:

Optional parameter to preload data upon creation of the datastore. Currently, the only supported preloaded data is synthetic data generated from Synthea.

PreloadDataType (string) -- [REQUIRED]

The type of preloaded data. Only Synthea preloaded data is supported.

type ClientToken:

string

param ClientToken:

Optional user provided token used for ensuring idempotency.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
    'DatastoreEndpoint': 'string'
}

Response Structure

(dict) --
- DatastoreId (string) --
  
  The AWS-generated datastore id. This id is in the output from the initial datastore creation call.
- DatastoreArn (string) --
  
  The datastore ARN is generated during the creation of the datastore and can be found in the output from the initial datastore creation call.
- DatastoreStatus (string) --
  
  The status of the FHIR datastore. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
- DatastoreEndpoint (string) --
  
  The AWS endpoint for the created datastore. For preview, only US-east-1 endpoints are supported.

DescribeFHIRImportJob (new)

Link ¶

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

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 datastore.

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'|'FAILED',
        'SubmitTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'DatastoreId': 'string',
        'InputDataConfig': {
            'S3Uri': 'string'
        },
        'DataAccessRoleArn': 'string',
        'Message': 'string'
    }
}

Response Structure

(dict) --
- ImportJobProperties (dict) --
  
  The properties of the Import job request, including the ID, ARN, name, and the status of the datastore.
  - 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, 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 Amazon HealthLake.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
  - Message (string) --
    
    An explanation of any errors that may have occurred during the FHIR import job.

DeleteFHIRDatastore (new)

Link ¶

Deletes a datastore.

See also: AWS API Documentation

Request Syntax

client.delete_fhir_datastore(
    DatastoreId='string'
)

type DatastoreId:

string

param DatastoreId:

The AWS-generated ID for the datastore to be deleted.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
    'DatastoreEndpoint': 'string'
}

Response Structure

(dict) --
- DatastoreId (string) --
  
  The AWS-generated ID for the datastore to be deleted.
- DatastoreArn (string) --
  
  The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
- DatastoreStatus (string) --
  
  The status of the datastore that the user has requested to be deleted.
- DatastoreEndpoint (string) --
  
  The AWS endpoint for the datastore the user has requested to be deleted.

DescribeFHIRDatastore (new)

Link ¶

Gets the properties associated with the FHIR datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.

See also: AWS API Documentation

Request Syntax

client.describe_fhir_datastore(
    DatastoreId='string'
)

type DatastoreId:

string

param DatastoreId:

The AWS-generated datastore id. This is part of the ‘CreateFHIRDatastore’ output.

rtype:

dict

returns:

Response Syntax

{
    'DatastoreProperties': {
        'DatastoreId': 'string',
        'DatastoreArn': 'string',
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
        'CreatedAt': datetime(2015, 1, 1),
        'DatastoreTypeVersion': 'R4',
        'DatastoreEndpoint': 'string',
        'PreloadDataConfig': {
            'PreloadDataType': 'SYNTHEA'
        }
    }
}

Response Structure

(dict) --
- DatastoreProperties (dict) --
  
  All properties associated with a datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.
  - DatastoreId (string) --
    
    The AWS-generated ID number for the datastore.
  - DatastoreArn (string) --
    
    The Amazon Resource Name used in the creation of the datastore.
  - DatastoreName (string) --
    
    The user-generated name for the datastore.
  - DatastoreStatus (string) --
    
    The status of the datastore. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
  - CreatedAt (datetime) --
    
    The time that a datastore was created.
  - DatastoreTypeVersion (string) --
    
    The FHIR version. Only R4 version data is supported.
  - DatastoreEndpoint (string) --
    
    The AWS endpoint for the datastore. Each datastore will have it's own endpoint with datastore ID in the endpoint URL.
  - PreloadDataConfig (dict) --
    
    The preloaded data configuration for the datastore. Only data preloaded from Synthea is supported.
    - PreloadDataType (string) --
      
      The type of preloaded data. Only Synthea preloaded data is supported.