2025/01/24 - Amazon HealthLake - 9 updated api methods
Changes Added new authorization strategy value 'SMART_ON_FHIR' for CreateFHIRDatastore API to support Smart App 2.0
{'IdentityProviderConfiguration': {'AuthorizationStrategy': {'SMART_ON_FHIR'}}}
Creates a data store that can ingest and export FHIR formatted data.
See also: AWS API Documentation
Request Syntax
client.create_fhir_datastore(
DatastoreName='string',
DatastoreTypeVersion='R4',
SseConfiguration={
'KmsEncryptionConfig': {
'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
'KmsKeyId': 'string'
}
},
PreloadDataConfig={
'PreloadDataType': 'SYNTHEA'
},
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
IdentityProviderConfiguration={
'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
'FineGrainedAuthorizationEnabled': True|False,
'Metadata': 'string',
'IdpLambdaArn': 'string'
}
)
string
The user generated name for the data store.
string
[REQUIRED]
The FHIR version of the data store. The only supported version is R4.
dict
The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
KmsEncryptionConfig (dict) -- [REQUIRED]
The KMS encryption configuration used to provide details for data encryption.
CmkType (string) -- [REQUIRED]
The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
KmsKeyId (string) --
The KMS encryption key id/alias used to encrypt the data store contents at rest.
dict
Optional parameter to preload data upon creation of the data store. 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.
string
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
list
Resource tags that are applied to a data store when it is created.
(dict) --
A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
Key (string) -- [REQUIRED]
The key portion of a tag. Tag keys are case sensitive.
Value (string) -- [REQUIRED]
The value portion of a tag. Tag values are case sensitive.
dict
The configuration of the identity provider that you want to use for your data store.
AuthorizationStrategy (string) -- [REQUIRED]
The authorization strategy that you selected when you created the data store.
FineGrainedAuthorizationEnabled (boolean) --
If you enabled fine-grained authorization when you created the data store.
Metadata (string) --
The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.
authorization_endpoint: The URL to the OAuth2 authorization endpoint.
grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.
token_endpoint: The URL to the OAuth2 token endpoint.
capabilities: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.
IdpLambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
dict
Response Syntax
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED',
'DatastoreEndpoint': 'string'
}
Response Structure
(dict) --
DatastoreId (string) --
The AWS-generated data store id. This id is in the output from the initial data store creation call.
DatastoreArn (string) --
The data store ARN is generated during the creation of the data store and can be found in the output from the initial data store creation call.
DatastoreStatus (string) --
The status of the FHIR data store.
DatastoreEndpoint (string) --
The AWS endpoint for the created data store.
{'DatastoreProperties': {'IdentityProviderConfiguration': {'AuthorizationStrategy': {'SMART_ON_FHIR'}}}}
Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_fhir_datastore(
DatastoreId='string'
)
string
[REQUIRED]
The AWS-generated data store ID.
dict
Response Syntax
{
'DatastoreProperties': {
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'DatastoreTypeVersion': 'R4',
'DatastoreEndpoint': 'string',
'SseConfiguration': {
'KmsEncryptionConfig': {
'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
'KmsKeyId': 'string'
}
},
'PreloadDataConfig': {
'PreloadDataType': 'SYNTHEA'
},
'IdentityProviderConfiguration': {
'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
'FineGrainedAuthorizationEnabled': True|False,
'Metadata': 'string',
'IdpLambdaArn': 'string'
},
'ErrorCause': {
'ErrorMessage': 'string',
'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
}
}
}
Response Structure
(dict) --
DatastoreProperties (dict) --
All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
DatastoreId (string) --
The AWS-generated ID number for the data store.
DatastoreArn (string) --
The Amazon Resource Name used in the creation of the data store.
DatastoreName (string) --
The user-generated name for the data store.
DatastoreStatus (string) --
The status of the data store.
CreatedAt (datetime) --
The time that a data store was created.
DatastoreTypeVersion (string) --
The FHIR version. Only R4 version data is supported.
DatastoreEndpoint (string) --
The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.
SseConfiguration (dict) --
The server-side encryption key configuration for a customer provided encryption key (CMK).
KmsEncryptionConfig (dict) --
The KMS encryption configuration used to provide details for data encryption.
CmkType (string) --
The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
KmsKeyId (string) --
The KMS encryption key id/alias used to encrypt the data store contents at rest.
PreloadDataConfig (dict) --
The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
PreloadDataType (string) --
The type of preloaded data. Only Synthea preloaded data is supported.
IdentityProviderConfiguration (dict) --
The identity provider that you selected when you created the data store.
AuthorizationStrategy (string) --
The authorization strategy that you selected when you created the data store.
FineGrainedAuthorizationEnabled (boolean) --
If you enabled fine-grained authorization when you created the data store.
Metadata (string) --
The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.
authorization_endpoint: The URL to the OAuth2 authorization endpoint.
grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.
token_endpoint: The URL to the OAuth2 token endpoint.
capabilities: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.
IdpLambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
ErrorCause (dict) --
The error cause for the current data store operation.
ErrorMessage (string) --
The text of the error message.
ErrorCategory (string) --
The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.
{'ExportJobProperties': {'JobStatus': {'QUEUED'}}}
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
client.describe_fhir_export_job(
DatastoreId='string',
JobId='string'
)
string
[REQUIRED]
The AWS generated ID for the data store from which files are being exported from for an export job.
string
[REQUIRED]
The AWS generated ID for an export job.
dict
Response Syntax
{
'ExportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'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.
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.
{'ImportJobProperties': {'JobStatus': {'QUEUED'}}}
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'
)
string
[REQUIRED]
The AWS-generated ID of the data store.
string
[REQUIRED]
The AWS-generated job ID.
dict
Response Syntax
{
'ImportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'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.
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.
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.
{'DatastorePropertiesList': {'IdentityProviderConfiguration': {'AuthorizationStrategy': {'SMART_ON_FHIR'}}}}
Lists all FHIR data stores that are in the user’s account, regardless of data store status.
See also: AWS API Documentation
Request Syntax
client.list_fhir_datastores(
Filter={
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED',
'CreatedBefore': datetime(2015, 1, 1),
'CreatedAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
dict
Lists all filters associated with a FHIR data store request.
DatastoreName (string) --
Allows the user to filter data store results by name.
DatastoreStatus (string) --
Allows the user to filter data store results by status.
CreatedBefore (datetime) --
A filter that allows the user to set cutoff dates for records. All data stores 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 data stores created after the specified date will be included in the results.
string
Fetches the next page of data stores when results are paginated.
integer
The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.
dict
Response Syntax
{
'DatastorePropertiesList': [
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'CREATE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'DatastoreTypeVersion': 'R4',
'DatastoreEndpoint': 'string',
'SseConfiguration': {
'KmsEncryptionConfig': {
'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
'KmsKeyId': 'string'
}
},
'PreloadDataConfig': {
'PreloadDataType': 'SYNTHEA'
},
'IdentityProviderConfiguration': {
'AuthorizationStrategy': 'SMART_ON_FHIR_V1'|'SMART_ON_FHIR'|'AWS_AUTH',
'FineGrainedAuthorizationEnabled': True|False,
'Metadata': 'string',
'IdpLambdaArn': 'string'
},
'ErrorCause': {
'ErrorMessage': 'string',
'ErrorCategory': 'RETRYABLE_ERROR'|'NON_RETRYABLE_ERROR'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DatastorePropertiesList (list) --
All properties associated with the listed data stores.
(dict) --
Displays the properties of the data store, including the ID, ARN, name, and the status of the data store.
DatastoreId (string) --
The AWS-generated ID number for the data store.
DatastoreArn (string) --
The Amazon Resource Name used in the creation of the data store.
DatastoreName (string) --
The user-generated name for the data store.
DatastoreStatus (string) --
The status of the data store.
CreatedAt (datetime) --
The time that a data store was created.
DatastoreTypeVersion (string) --
The FHIR version. Only R4 version data is supported.
DatastoreEndpoint (string) --
The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.
SseConfiguration (dict) --
The server-side encryption key configuration for a customer provided encryption key (CMK).
KmsEncryptionConfig (dict) --
The KMS encryption configuration used to provide details for data encryption.
CmkType (string) --
The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
KmsKeyId (string) --
The KMS encryption key id/alias used to encrypt the data store contents at rest.
PreloadDataConfig (dict) --
The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
PreloadDataType (string) --
The type of preloaded data. Only Synthea preloaded data is supported.
IdentityProviderConfiguration (dict) --
The identity provider that you selected when you created the data store.
AuthorizationStrategy (string) --
The authorization strategy that you selected when you created the data store.
FineGrainedAuthorizationEnabled (boolean) --
If you enabled fine-grained authorization when you created the data store.
Metadata (string) --
The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.
authorization_endpoint: The URL to the OAuth2 authorization endpoint.
grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.
token_endpoint: The URL to the OAuth2 token endpoint.
capabilities: An array of strings of the SMART capabilities that the authorization server supports.
code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.
IdpLambdaArn (string) --
The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
ErrorCause (dict) --
The error cause for the current data store operation.
ErrorMessage (string) --
The text of the error message.
ErrorCategory (string) --
The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.
NextToken (string) --
Pagination token that can be used to retrieve the next page of results.
{'JobStatus': {'QUEUED'}}
Response {'ExportJobPropertiesList': {'JobStatus': {'QUEUED'}}}
Lists all FHIR export jobs associated with an account and their statuses.
See also: AWS API Documentation
Request Syntax
client.list_fhir_export_jobs(
DatastoreId='string',
NextToken='string',
MaxResults=123,
JobName='string',
JobStatus='SUBMITTED'|'QUEUED'|'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)
)
string
[REQUIRED]
This parameter limits the response to the export job with the specified data store ID.
string
A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
integer
This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
string
This parameter limits the response to the export job with the specified job name.
string
This parameter limits the response to the export jobs with the specified job status.
datetime
This parameter limits the response to FHIR export jobs submitted before a user specified date.
datetime
This parameter limits the response to FHIR export jobs submitted after a user specified date.
dict
Response Syntax
{
'ExportJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExportJobPropertiesList (list) --
The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
(dict) --
The properties of a FHIR 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.
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.
NextToken (string) --
A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
{'JobStatus': {'QUEUED'}}
Response {'ImportJobPropertiesList': {'JobStatus': {'QUEUED'}}}
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'|'QUEUED'|'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)
)
string
[REQUIRED]
This parameter limits the response to the import job with the specified data store ID.
string
A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
integer
This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
string
This parameter limits the response to the import job with the specified job name.
string
This parameter limits the response to the import job with the specified job status.
datetime
This parameter limits the response to FHIR import jobs submitted before a user specified date.
datetime
This parameter limits the response to FHIR import jobs submitted after a user specified date.
dict
Response Syntax
{
'ImportJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'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.
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.
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.
{'JobStatus': {'QUEUED'}}
Begins a FHIR export job.
See also: AWS API Documentation
Request Syntax
client.start_fhir_export_job(
JobName='string',
OutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string'
)
string
The user generated name for an export job.
dict
[REQUIRED]
The output data configuration that was supplied when the export job was created.
S3Configuration (dict) --
The output data configuration that was supplied when the export job was created.
S3Uri (string) -- [REQUIRED]
The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
KmsKeyId (string) -- [REQUIRED]
The KMS key ID used to access the S3 bucket.
string
[REQUIRED]
The AWS generated ID for the data store from which files are being exported for an export job.
string
[REQUIRED]
The Amazon Resource Name used during the initiation of the job.
string
An optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_FAILED',
'DatastoreId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The AWS generated ID for an export job.
JobStatus (string) --
The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
DatastoreId (string) --
The AWS generated ID for the data store from which files are being exported for an export job.
{'JobStatus': {'QUEUED'}}
Begins a FHIR Import job.
See also: AWS API Documentation
Request Syntax
client.start_fhir_import_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string'
},
JobOutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string'
)
string
The name of the FHIR Import job in the StartFHIRImport job request.
dict
[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 AWS HealthLake.
dict
[REQUIRED]
The output data configuration that was supplied when the export job was created.
S3Configuration (dict) --
The output data configuration that was supplied when the export job was created.
S3Uri (string) -- [REQUIRED]
The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
KmsKeyId (string) -- [REQUIRED]
The KMS key ID used to access the S3 bucket.
string
[REQUIRED]
The AWS-generated data store ID.
string
[REQUIRED]
The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
string
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'QUEUED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED'|'CANCEL_SUBMITTED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETED'|'CANCEL_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 data store ID.