Table of Contents
HealthLake.Client¶A low-level client representing Amazon HealthLake
Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.
import boto3
client = boto3.client('healthlake')
These are the available methods:
can_paginate()close()create_fhir_datastore()delete_fhir_datastore()describe_fhir_datastore()describe_fhir_export_job()describe_fhir_import_job()get_paginator()get_waiter()list_fhir_datastores()list_fhir_export_jobs()list_fhir_import_jobs()list_tags_for_resource()start_fhir_export_job()start_fhir_import_job()tag_resource()untag_resource()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_fhir_datastore(**kwargs)¶Creates a Data Store that can ingest and export FHIR formatted data.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
[REQUIRED]
The FHIR version of the Data Store. The only supported version is R4.
The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store.
The KMS encryption configuration used to provide details for data encryption.
The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
The type of preloaded data. Only Synthea preloaded data is supported.
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
Resource tags that are applied to a Data Store when it is created.
A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
The key portion of a tag. Tag keys are case sensitive.
The value portion of tag. Tag values are case sensitive.
dict
Response Syntax
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'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 datastore 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. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
DatastoreEndpoint (string) --
The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.InternalServerExceptiondelete_fhir_datastore(**kwargs)¶Deletes a Data Store.
See also: AWS API Documentation
Request Syntax
response = client.delete_fhir_datastore(
DatastoreId='string'
)
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'DatastoreEndpoint': 'string'
}
Response Structure
The AWS-generated ID for the Data Store to be deleted.
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
The status of the Data Store that the user has requested to be deleted.
The AWS endpoint for the Data Store the user has requested to be deleted.
Exceptions
HealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.ConflictExceptionHealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptiondescribe_fhir_datastore(**kwargs)¶Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_fhir_datastore(
DatastoreId='string'
)
{
'DatastoreProperties': {
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'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'
}
}
}
Response Structure
All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.
The AWS-generated ID number for the Data Store.
The Amazon Resource Name used in the creation of the Data Store.
The user-generated name for the Data Store.
The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
The time that a Data Store was created.
The FHIR version. Only R4 version data is supported.
The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL.
The server-side encryption key configuration for a customer provided encryption key (CMK).
The KMS encryption configuration used to provide details for data encryption.
The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
The KMS encryption key id/alias used to encrypt the Data Store contents at rest.
The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
The type of preloaded data. Only Synthea preloaded data is supported.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptiondescribe_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'
)
[REQUIRED]
The AWS generated ID for the Data Store from which files are being exported from for an export job.
[REQUIRED]
The AWS generated ID for an export job.
dict
Response Syntax
{
'ExportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'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 Amazon 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.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptiondescribe_fhir_import_job(**kwargs)¶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
response = client.describe_fhir_import_job(
DatastoreId='string',
JobId='string'
)
[REQUIRED]
The AWS-generated ID of the Data Store.
[REQUIRED]
The AWS-generated job ID.
dict
Response Syntax
{
'ImportJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DatastoreId': 'string',
'InputDataConfig': {
'S3Uri': 'string'
},
'JobOutputDataConfig': {
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': '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 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, 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.
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 Amazon HealthLake.
KmsKeyId (string) --
The KMS key ID used to access the S3 bucket.
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.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_fhir_datastores(**kwargs)¶Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.
See also: AWS API Documentation
Request Syntax
response = 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
)
Lists all filters associated with a FHIR Data Store request.
Allows the user to filter Data Store results by name.
Allows the user to filter Data Store results by status.
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.
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.
dict
Response Syntax
{
'DatastorePropertiesList': [
{
'DatastoreId': 'string',
'DatastoreArn': 'string',
'DatastoreName': 'string',
'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
'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'
}
},
],
'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. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
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 encyrption. 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.
NextToken (string) --
Pagination token that can be used to retrieve the next page of results.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptionlist_fhir_export_jobs(**kwargs)¶Lists all FHIR export jobs associated with an account and their statuses.
See also: AWS API Documentation
Request Syntax
response = client.list_fhir_export_jobs(
DatastoreId='string',
NextToken='string',
MaxResults=123,
JobName='string',
JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED',
SubmittedBefore=datetime(2015, 1, 1),
SubmittedAfter=datetime(2015, 1, 1)
)
[REQUIRED]
This parameter limits the response to the export job with the specified Data Store ID.
dict
Response Syntax
{
'ExportJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'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.
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 Amazon 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.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptionlist_fhir_import_jobs(**kwargs)¶Lists all FHIR import jobs associated with an account and their statuses.
See also: AWS API Documentation
Request Syntax
response = client.list_fhir_import_jobs(
DatastoreId='string',
NextToken='string',
MaxResults=123,
JobName='string',
JobStatus='SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED',
SubmittedBefore=datetime(2015, 1, 1),
SubmittedAfter=datetime(2015, 1, 1)
)
[REQUIRED]
This parameter limits the response to the import job with the specified Data Store ID.
dict
Response Syntax
{
'ImportJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'FAILED',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'DatastoreId': 'string',
'InputDataConfig': {
'S3Uri': 'string'
},
'JobOutputDataConfig': {
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
'DataAccessRoleArn': 'string',
'Message': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ImportJobPropertiesList (list) --
The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.
(dict) --
Displays the properties of the import job, including the ID, Arn, Name, and the status of the Data Store.
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.
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 Amazon HealthLake.
KmsKeyId (string) --
The KMS key ID used to access the S3 bucket.
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.
NextToken (string) --
A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.InternalServerExceptionReturns a list of all existing tags associated with a Data Store.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name(ARN) of the Data Store for which tags are being added.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
Returns a list of tags associated with a Data Store.
A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
The key portion of a tag. Tag keys are case sensitive.
The value portion of tag. Tag values are case sensitive.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionstart_fhir_export_job(**kwargs)¶Begins a FHIR export job.
See also: AWS API Documentation
Request Syntax
response = client.start_fhir_export_job(
JobName='string',
OutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string'
)
[REQUIRED]
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 can be set: S3Configuration.
The output data configuration that was supplied when the export job was created.
The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
The KMS key ID used to access the S3 bucket.
[REQUIRED]
The AWS generated ID for the Data Store from which files are being exported for an export job.
[REQUIRED]
The Amazon Resource Name used during the initiation of the job.
[REQUIRED]
An optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'COMPLETED'|'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.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.InternalServerExceptionstart_fhir_import_job(**kwargs)¶Begins a FHIR Import job.
See also: AWS API Documentation
Request Syntax
response = client.start_fhir_import_job(
JobName='string',
InputDataConfig={
'S3Uri': 'string'
},
JobOutputDataConfig={
'S3Configuration': {
'S3Uri': 'string',
'KmsKeyId': 'string'
}
},
DatastoreId='string',
DataAccessRoleArn='string',
ClientToken='string'
)
[REQUIRED]
The input properties of the FHIR Import job in the StartFHIRImport job request.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: S3Uri.
The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
[REQUIRED]
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 can be set: S3Configuration.
The output data configuration that was supplied when the export job was created.
The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
The KMS key ID used to access the S3 bucket.
[REQUIRED]
The AWS-generated Data Store ID.
[REQUIRED]
The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
[REQUIRED]
Optional user provided token used for ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'JobId': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED_WITH_ERRORS'|'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 Data Store ID.
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ThrottlingExceptionHealthLake.Client.exceptions.AccessDeniedExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionHealthLake.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Adds a user specifed key and value tag to a Data Store.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to.
[REQUIRED]
The user specified key and value pair tags being added to a Data Store.
A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"}
The key portion of a tag. Tag keys are case sensitive.
The value portion of tag. Tag values are case sensitive.
dict
Response Syntax
{}
Response Structure
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes tags from a Data Store.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
"The Amazon Resource Name(ARN) of the Data Store for which tags are being removed
[REQUIRED]
The keys for the tags to be removed from the Healthlake Data Store.
dict
Response Syntax
{}
Response Structure
Exceptions
HealthLake.Client.exceptions.ValidationExceptionHealthLake.Client.exceptions.ResourceNotFoundExceptionThe available paginators are: