HealthLakeClient#
Index > HealthLake > HealthLakeClient
Auto-generated documentation for HealthLake type annotations stubs module mypy-boto3-healthlake.
HealthLakeClient#
Type annotations and code completion for boto3.client("healthlake").
boto3 documentation
# HealthLakeClient usage example
from boto3.session import Session
from mypy_boto3_healthlake.client import HealthLakeClient
def get_healthlake_client() -> HealthLakeClient:
return Session().client("healthlake")
Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("healthlake").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("healthlake")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.AgentMessageOutOfContextException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ConversationNotFoundException,
client.exceptions.FailedDependencyException,
client.exceptions.InternalServerException,
client.exceptions.NotImplementedOperationException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.UnauthorizedException,
client.exceptions.UnsupportedMIMETypeException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_healthlake.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("healthlake").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("healthlake").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
create_data_transformation_profile#
Creates a data transformation profile in DRAFT state.
Type annotations and code completion for boto3.client("healthlake").create_data_transformation_profile method.
boto3 documentation
# create_data_transformation_profile method definition
def create_data_transformation_profile(
self,
*,
SourceFormat: SourceFormatType, # (1)
Source: CreateDataTransformationProfileSourceTypeDef, # (2)
ProfileName: str,
KmsKeyId: str = ...,
ProfileDescription: str = ...,
Tags: Mapping[str, str] = ...,
ClientToken: str = ...,
) -> CreateDataTransformationProfileResponseTypeDef: # (3)
...
- See SourceFormatType
- See CreateDataTransformationProfileSourceTypeDef
- See CreateDataTransformationProfileResponseTypeDef
# create_data_transformation_profile method usage example with argument unpacking
kwargs: CreateDataTransformationProfileRequestTypeDef = { # (1)
"SourceFormat": ...,
"Source": ...,
"ProfileName": ...,
}
parent.create_data_transformation_profile(**kwargs)
create_fhir_datastore#
Create a FHIR-enabled data store.
Type annotations and code completion for boto3.client("healthlake").create_fhir_datastore method.
boto3 documentation
# create_fhir_datastore method definition
def create_fhir_datastore(
self,
*,
DatastoreTypeVersion: FHIRVersionType, # (1)
DatastoreName: str = ...,
SseConfiguration: SseConfigurationTypeDef = ..., # (2)
PreloadDataConfig: PreloadDataConfigTypeDef = ..., # (3)
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
IdentityProviderConfiguration: IdentityProviderConfigurationTypeDef = ..., # (5)
AnalyticsConfiguration: AnalyticsConfigurationTypeDef = ..., # (6)
NlpConfiguration: NlpConfigurationTypeDef = ..., # (7)
ProfileConfiguration: ProfileConfigurationUnionTypeDef = ..., # (8)
) -> CreateFHIRDatastoreResponseTypeDef: # (9)
...
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
- See
Sequence[TagTypeDef] - See IdentityProviderConfigurationTypeDef
- See AnalyticsConfigurationTypeDef
- See NlpConfigurationTypeDef
- See ProfileConfigurationUnionTypeDef
- See CreateFHIRDatastoreResponseTypeDef
# create_fhir_datastore method usage example with argument unpacking
kwargs: CreateFHIRDatastoreRequestTypeDef = { # (1)
"DatastoreTypeVersion": ...,
}
parent.create_fhir_datastore(**kwargs)
delete_data_transformation_profile#
Deletes a data transformation profile and all its versions, including the DRAFT and all published versions.
Type annotations and code completion for boto3.client("healthlake").delete_data_transformation_profile method.
boto3 documentation
# delete_data_transformation_profile method definition
def delete_data_transformation_profile(
self,
*,
ProfileId: str,
) -> DeleteDataTransformationProfileResponseTypeDef: # (1)
...
# delete_data_transformation_profile method usage example with argument unpacking
kwargs: DeleteDataTransformationProfileRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.delete_data_transformation_profile(**kwargs)
delete_fhir_datastore#
Delete a FHIR-enabled data store.
Type annotations and code completion for boto3.client("healthlake").delete_fhir_datastore method.
boto3 documentation
# delete_fhir_datastore method definition
def delete_fhir_datastore(
self,
*,
DatastoreId: str,
) -> DeleteFHIRDatastoreResponseTypeDef: # (1)
...
# delete_fhir_datastore method usage example with argument unpacking
kwargs: DeleteFHIRDatastoreRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.delete_fhir_datastore(**kwargs)
describe_data_transformation_job#
Describes a data transformation job, including its current status, configuration, and progress information.
Type annotations and code completion for boto3.client("healthlake").describe_data_transformation_job method.
boto3 documentation
# describe_data_transformation_job method definition
def describe_data_transformation_job(
self,
*,
JobId: str,
) -> DescribeDataTransformationJobResponseTypeDef: # (1)
...
# describe_data_transformation_job method usage example with argument unpacking
kwargs: DescribeDataTransformationJobRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_data_transformation_job(**kwargs)
describe_fhir_datastore#
Get properties for a FHIR-enabled data store.
Type annotations and code completion for boto3.client("healthlake").describe_fhir_datastore method.
boto3 documentation
# describe_fhir_datastore method definition
def describe_fhir_datastore(
self,
*,
DatastoreId: str,
) -> DescribeFHIRDatastoreResponseTypeDef: # (1)
...
# describe_fhir_datastore method usage example with argument unpacking
kwargs: DescribeFHIRDatastoreRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.describe_fhir_datastore(**kwargs)
describe_fhir_export_job#
Get FHIR export job properties.
Type annotations and code completion for boto3.client("healthlake").describe_fhir_export_job method.
boto3 documentation
# describe_fhir_export_job method definition
def describe_fhir_export_job(
self,
*,
DatastoreId: str,
JobId: str,
) -> DescribeFHIRExportJobResponseTypeDef: # (1)
...
# describe_fhir_export_job method usage example with argument unpacking
kwargs: DescribeFHIRExportJobRequestTypeDef = { # (1)
"DatastoreId": ...,
"JobId": ...,
}
parent.describe_fhir_export_job(**kwargs)
describe_fhir_import_job#
Get the import job properties to learn more about the job or job progress.
Type annotations and code completion for boto3.client("healthlake").describe_fhir_import_job method.
boto3 documentation
# describe_fhir_import_job method definition
def describe_fhir_import_job(
self,
*,
DatastoreId: str,
JobId: str,
) -> DescribeFHIRImportJobResponseTypeDef: # (1)
...
# describe_fhir_import_job method usage example with argument unpacking
kwargs: DescribeFHIRImportJobRequestTypeDef = { # (1)
"DatastoreId": ...,
"JobId": ...,
}
parent.describe_fhir_import_job(**kwargs)
get_data_transformation_profile#
Retrieves a data transformation profile's metadata and profile content at a specific version.
Type annotations and code completion for boto3.client("healthlake").get_data_transformation_profile method.
boto3 documentation
# get_data_transformation_profile method definition
def get_data_transformation_profile(
self,
*,
ProfileId: str,
ProfileVersion: int = ...,
) -> GetDataTransformationProfileResponseTypeDef: # (1)
...
# get_data_transformation_profile method usage example with argument unpacking
kwargs: GetDataTransformationProfileRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.get_data_transformation_profile(**kwargs)
list_data_transformation_jobs#
Lists data transformation jobs for your AWS account.
Type annotations and code completion for boto3.client("healthlake").list_data_transformation_jobs method.
boto3 documentation
# list_data_transformation_jobs method definition
def list_data_transformation_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
JobStatus: TransformationJobStatusType = ..., # (1)
JobName: str = ...,
SubmittedAfter: TimestampTypeDef = ...,
SubmittedBefore: TimestampTypeDef = ...,
) -> ListDataTransformationJobsResponseTypeDef: # (2)
...
# list_data_transformation_jobs method usage example with argument unpacking
kwargs: ListDataTransformationJobsRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_data_transformation_jobs(**kwargs)
list_data_transformation_profile_versions#
Lists all versions of a specific data transformation profile (DRAFT and published), in reverse chronological order (newest first).
Type annotations and code completion for boto3.client("healthlake").list_data_transformation_profile_versions method.
boto3 documentation
# list_data_transformation_profile_versions method definition
def list_data_transformation_profile_versions(
self,
*,
ProfileId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDataTransformationProfileVersionsResponseTypeDef: # (1)
...
# list_data_transformation_profile_versions method usage example with argument unpacking
kwargs: ListDataTransformationProfileVersionsRequestTypeDef = { # (1)
"ProfileId": ...,
}
parent.list_data_transformation_profile_versions(**kwargs)
list_data_transformation_profiles#
Lists all data transformation profiles in your account, returning the latest version summary for each.
Type annotations and code completion for boto3.client("healthlake").list_data_transformation_profiles method.
boto3 documentation
# list_data_transformation_profiles method definition
def list_data_transformation_profiles(
self,
*,
SourceFormat: SourceFormatType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDataTransformationProfilesResponseTypeDef: # (2)
...
# list_data_transformation_profiles method usage example with argument unpacking
kwargs: ListDataTransformationProfilesRequestTypeDef = { # (1)
"SourceFormat": ...,
}
parent.list_data_transformation_profiles(**kwargs)
list_fhir_datastores#
List all FHIR-enabled data stores in a user's account, regardless of data store status.
Type annotations and code completion for boto3.client("healthlake").list_fhir_datastores method.
boto3 documentation
# list_fhir_datastores method definition
def list_fhir_datastores(
self,
*,
Filter: DatastoreFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFHIRDatastoresResponseTypeDef: # (2)
...
# list_fhir_datastores method usage example with argument unpacking
kwargs: ListFHIRDatastoresRequestTypeDef = { # (1)
"Filter": ...,
}
parent.list_fhir_datastores(**kwargs)
list_fhir_export_jobs#
Lists all FHIR export jobs associated with an account and their statuses.
Type annotations and code completion for boto3.client("healthlake").list_fhir_export_jobs method.
boto3 documentation
# list_fhir_export_jobs method definition
def list_fhir_export_jobs(
self,
*,
DatastoreId: str,
NextToken: str = ...,
MaxResults: int = ...,
JobName: str = ...,
JobStatus: JobStatusType = ..., # (1)
SubmittedBefore: TimestampTypeDef = ...,
SubmittedAfter: TimestampTypeDef = ...,
) -> ListFHIRExportJobsResponseTypeDef: # (2)
...
# list_fhir_export_jobs method usage example with argument unpacking
kwargs: ListFHIRExportJobsRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.list_fhir_export_jobs(**kwargs)
list_fhir_import_jobs#
List all FHIR import jobs associated with an account and their statuses.
Type annotations and code completion for boto3.client("healthlake").list_fhir_import_jobs method.
boto3 documentation
# list_fhir_import_jobs method definition
def list_fhir_import_jobs(
self,
*,
DatastoreId: str,
NextToken: str = ...,
MaxResults: int = ...,
JobName: str = ...,
JobStatus: JobStatusType = ..., # (1)
SubmittedBefore: TimestampTypeDef = ...,
SubmittedAfter: TimestampTypeDef = ...,
) -> ListFHIRImportJobsResponseTypeDef: # (2)
...
# list_fhir_import_jobs method usage example with argument unpacking
kwargs: ListFHIRImportJobsRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.list_fhir_import_jobs(**kwargs)
list_tags_for_resource#
Returns a list of all existing tags associated with a data store.
Type annotations and code completion for boto3.client("healthlake").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
publish_data_transformation_profile#
Promotes the current DRAFT version of a data transformation profile to a new immutable published version.
Type annotations and code completion for boto3.client("healthlake").publish_data_transformation_profile method.
boto3 documentation
# publish_data_transformation_profile method definition
def publish_data_transformation_profile(
self,
*,
ProfileId: str,
SourceFormat: SourceFormatType, # (1)
FromExistingVersion: int = ...,
ChangeDescription: str = ...,
) -> PublishDataTransformationProfileResponseTypeDef: # (2)
...
# publish_data_transformation_profile method usage example with argument unpacking
kwargs: PublishDataTransformationProfileRequestTypeDef = { # (1)
"ProfileId": ...,
"SourceFormat": ...,
}
parent.publish_data_transformation_profile(**kwargs)
start_data_transformation_job#
Starts an asynchronous data transformation job that converts source files from Amazon Simple Storage Service (Amazon S3) and writes the output to Amazon S3 or AWS HealthLake.
Type annotations and code completion for boto3.client("healthlake").start_data_transformation_job method.
boto3 documentation
# start_data_transformation_job method definition
def start_data_transformation_job(
self,
*,
InputDataConfig: TransformationInputDataConfigTypeDef, # (1)
OutputDataConfig: TransformationOutputDataConfigTypeDef, # (2)
DataAccessRoleArn: str,
ClientToken: str,
ProfileId: str,
JobName: str = ...,
DriftDetectionEnabled: bool = ...,
ProvenanceEnabled: bool = ...,
) -> StartDataTransformationJobResponseTypeDef: # (3)
...
- See TransformationInputDataConfigTypeDef
- See TransformationOutputDataConfigTypeDef
- See StartDataTransformationJobResponseTypeDef
# start_data_transformation_job method usage example with argument unpacking
kwargs: StartDataTransformationJobRequestTypeDef = { # (1)
"InputDataConfig": ...,
"OutputDataConfig": ...,
"DataAccessRoleArn": ...,
"ClientToken": ...,
"ProfileId": ...,
}
parent.start_data_transformation_job(**kwargs)
start_fhir_export_job#
Start a FHIR export job.
Type annotations and code completion for boto3.client("healthlake").start_fhir_export_job method.
boto3 documentation
# start_fhir_export_job method definition
def start_fhir_export_job(
self,
*,
OutputDataConfig: OutputDataConfigTypeDef, # (1)
DatastoreId: str,
DataAccessRoleArn: str,
JobName: str = ...,
ClientToken: str = ...,
) -> StartFHIRExportJobResponseTypeDef: # (2)
...
# start_fhir_export_job method usage example with argument unpacking
kwargs: StartFHIRExportJobRequestTypeDef = { # (1)
"OutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
}
parent.start_fhir_export_job(**kwargs)
start_fhir_import_job#
Start importing bulk FHIR data into an ACTIVE data store.
Type annotations and code completion for boto3.client("healthlake").start_fhir_import_job method.
boto3 documentation
# start_fhir_import_job method definition
def start_fhir_import_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
JobOutputDataConfig: OutputDataConfigTypeDef, # (2)
DatastoreId: str,
DataAccessRoleArn: str,
JobName: str = ...,
ClientToken: str = ...,
ValidationLevel: ValidationLevelType = ..., # (3)
ProfileId: str = ...,
InputFormat: str = ...,
DriftDetectionEnabled: bool = ...,
) -> StartFHIRImportJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See ValidationLevelType
- See StartFHIRImportJobResponseTypeDef
# start_fhir_import_job method usage example with argument unpacking
kwargs: StartFHIRImportJobRequestTypeDef = { # (1)
"InputDataConfig": ...,
"JobOutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
}
parent.start_fhir_import_job(**kwargs)
tag_resource#
Add a user-specifed key and value tag to a data store.
Type annotations and code completion for boto3.client("healthlake").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> dict[str, Any]:
...
- See
Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Remove a user-specifed key and value tag from a data store.
Type annotations and code completion for boto3.client("healthlake").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_data_transformation_profile#
Updates the DRAFT version (version 0) of a data transformation profile with new profile content.
Type annotations and code completion for boto3.client("healthlake").update_data_transformation_profile method.
boto3 documentation
# update_data_transformation_profile method definition
def update_data_transformation_profile(
self,
*,
ProfileId: str,
ProfileMapping: Mapping[str, str],
ChangeDescription: str = ...,
) -> UpdateDataTransformationProfileResponseTypeDef: # (1)
...
# update_data_transformation_profile method usage example with argument unpacking
kwargs: UpdateDataTransformationProfileRequestTypeDef = { # (1)
"ProfileId": ...,
"ProfileMapping": ...,
}
parent.update_data_transformation_profile(**kwargs)
update_fhir_datastore#
Update the properties of a FHIR-enabled data store.
Type annotations and code completion for boto3.client("healthlake").update_fhir_datastore method.
boto3 documentation
# update_fhir_datastore method definition
def update_fhir_datastore(
self,
*,
DatastoreId: str,
DatastoreName: str = ...,
AnalyticsConfiguration: AnalyticsConfigurationTypeDef = ..., # (1)
NlpConfiguration: NlpConfigurationTypeDef = ..., # (2)
ProfileConfiguration: ProfileConfigurationUnionTypeDef = ..., # (3)
IdentityProviderConfiguration: IdentityProviderConfigurationTypeDef = ..., # (4)
) -> UpdateFHIRDatastoreResponseTypeDef: # (5)
...
- See AnalyticsConfigurationTypeDef
- See NlpConfigurationTypeDef
- See ProfileConfigurationUnionTypeDef
- See IdentityProviderConfigurationTypeDef
- See UpdateFHIRDatastoreResponseTypeDef
# update_fhir_datastore method usage example with argument unpacking
kwargs: UpdateFHIRDatastoreRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.update_fhir_datastore(**kwargs)
update_profile_with_agent#
Updates a data transformation profile using chat-based interaction with an agent.
Type annotations and code completion for boto3.client("healthlake").update_profile_with_agent method.
boto3 documentation
# update_profile_with_agent method definition
def update_profile_with_agent(
self,
*,
ProfileId: str,
SourceFormat: SourceFormatType, # (1)
InputMessage: AgentInputMessageTypeDef, # (2)
ConversationId: str = ...,
) -> UpdateProfileWithAgentResponseTypeDef: # (3)
...
# update_profile_with_agent method usage example with argument unpacking
kwargs: UpdateProfileWithAgentRequestTypeDef = { # (1)
"ProfileId": ...,
"SourceFormat": ...,
"InputMessage": ...,
}
parent.update_profile_with_agent(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("healthlake").get_paginator method with overloads.
client.get_paginator("list_data_transformation_jobs")-> ListDataTransformationJobsPaginatorclient.get_paginator("list_data_transformation_profile_versions")-> ListDataTransformationProfileVersionsPaginatorclient.get_paginator("list_data_transformation_profiles")-> ListDataTransformationProfilesPaginator
get_waiter#
Type annotations and code completion for boto3.client("healthlake").get_waiter method with overloads.
client.get_waiter("data_transformation_job_completed")-> DataTransformationJobCompletedWaiterclient.get_waiter("fhir_datastore_active")-> FHIRDatastoreActiveWaiterclient.get_waiter("fhir_datastore_deleted")-> FHIRDatastoreDeletedWaiterclient.get_waiter("fhir_export_job_completed")-> FHIRExportJobCompletedWaiterclient.get_waiter("fhir_import_job_completed")-> FHIRImportJobCompletedWaiter