HealthLakeClient#
Index > HealthLake > HealthLakeClient
Auto-generated documentation for HealthLake type annotations stubs module types-boto3-healthlake.
HealthLakeClient#
Type annotations and code completion for boto3.client("healthlake")
.
boto3 documentation
# HealthLakeClient usage example
from boto3.session import Session
from types_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.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from types_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_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)
) -> CreateFHIRDatastoreResponseTypeDef: # (6)
...
- See FHIRVersionType
- See SseConfigurationTypeDef
- See PreloadDataConfigTypeDef
- See
Sequence[TagTypeDef]
- See IdentityProviderConfigurationTypeDef
- See CreateFHIRDatastoreResponseTypeDef
# create_fhir_datastore method usage example with argument unpacking
kwargs: CreateFHIRDatastoreRequestTypeDef = { # (1)
"DatastoreTypeVersion": ...,
}
parent.create_fhir_datastore(**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_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)
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)
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)
) -> 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)
get_waiter#
Type annotations and code completion for boto3.client("healthlake").get_waiter
method with overloads.
client.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