HealthLakeClient#
Index > HealthLake > HealthLakeClient
Auto-generated documentation for HealthLake type annotations stubs module types-aiobotocore-healthlake.
HealthLakeClient#
Type annotations and code completion for session.create_client("healthlake")
boto3 documentation
HealthLakeClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_healthlake.client import HealthLakeClient
session = get_session()
async with session.create_client("healthlake") as client:
client: HealthLakeClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("healthlake").exceptions
structure.
HealthLakeClient.exceptions usage example
async with session.create_client("healthlake") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
HealthLakeClient usage type checking example
from types_aiobotocore_healthlake.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("healthlake").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("healthlake").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_fhir_datastore#
Creates a data store that can ingest and export FHIR formatted data.
Type annotations and code completion for session.create_client("healthlake").create_fhir_datastore
method.
boto3 documentation
# create_fhir_datastore method definition
await 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 TagTypeDef
- See IdentityProviderConfigurationTypeDef
- See CreateFHIRDatastoreResponseTypeDef
# create_fhir_datastore method usage example with argument unpacking
kwargs: CreateFHIRDatastoreRequestRequestTypeDef = { # (1)
"DatastoreTypeVersion": ...,
}
parent.create_fhir_datastore(**kwargs)
delete_fhir_datastore#
Deletes a data store.
Type annotations and code completion for session.create_client("healthlake").delete_fhir_datastore
method.
boto3 documentation
# delete_fhir_datastore method definition
await def delete_fhir_datastore(
self,
*,
DatastoreId: str,
) -> DeleteFHIRDatastoreResponseTypeDef: # (1)
...
# delete_fhir_datastore method usage example with argument unpacking
kwargs: DeleteFHIRDatastoreRequestRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.delete_fhir_datastore(**kwargs)
describe_fhir_datastore#
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.
Type annotations and code completion for session.create_client("healthlake").describe_fhir_datastore
method.
boto3 documentation
# describe_fhir_datastore method definition
await def describe_fhir_datastore(
self,
*,
DatastoreId: str,
) -> DescribeFHIRDatastoreResponseTypeDef: # (1)
...
# describe_fhir_datastore method usage example with argument unpacking
kwargs: DescribeFHIRDatastoreRequestRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.describe_fhir_datastore(**kwargs)
describe_fhir_export_job#
Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.
Type annotations and code completion for session.create_client("healthlake").describe_fhir_export_job
method.
boto3 documentation
# describe_fhir_export_job method definition
await def describe_fhir_export_job(
self,
*,
DatastoreId: str,
JobId: str,
) -> DescribeFHIRExportJobResponseTypeDef: # (1)
...
# describe_fhir_export_job method usage example with argument unpacking
kwargs: DescribeFHIRExportJobRequestRequestTypeDef = { # (1)
"DatastoreId": ...,
"JobId": ...,
}
parent.describe_fhir_export_job(**kwargs)
describe_fhir_import_job#
Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
Type annotations and code completion for session.create_client("healthlake").describe_fhir_import_job
method.
boto3 documentation
# describe_fhir_import_job method definition
await def describe_fhir_import_job(
self,
*,
DatastoreId: str,
JobId: str,
) -> DescribeFHIRImportJobResponseTypeDef: # (1)
...
# describe_fhir_import_job method usage example with argument unpacking
kwargs: DescribeFHIRImportJobRequestRequestTypeDef = { # (1)
"DatastoreId": ...,
"JobId": ...,
}
parent.describe_fhir_import_job(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("healthlake").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_fhir_datastores#
Lists all FHIR data stores that are in the user’s account, regardless of data store status.
Type annotations and code completion for session.create_client("healthlake").list_fhir_datastores
method.
boto3 documentation
# list_fhir_datastores method definition
await def list_fhir_datastores(
self,
*,
Filter: DatastoreFilterTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFHIRDatastoresResponseTypeDef: # (2)
...
# list_fhir_datastores method usage example with argument unpacking
kwargs: ListFHIRDatastoresRequestRequestTypeDef = { # (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 session.create_client("healthlake").list_fhir_export_jobs
method.
boto3 documentation
# list_fhir_export_jobs method definition
await def list_fhir_export_jobs(
self,
*,
DatastoreId: str,
NextToken: str = ...,
MaxResults: int = ...,
JobName: str = ...,
JobStatus: JobStatusType = ..., # (1)
SubmittedBefore: Union[datetime, str] = ...,
SubmittedAfter: Union[datetime, str] = ...,
) -> ListFHIRExportJobsResponseTypeDef: # (2)
...
# list_fhir_export_jobs method usage example with argument unpacking
kwargs: ListFHIRExportJobsRequestRequestTypeDef = { # (1)
"DatastoreId": ...,
}
parent.list_fhir_export_jobs(**kwargs)
list_fhir_import_jobs#
Lists all FHIR import jobs associated with an account and their statuses.
Type annotations and code completion for session.create_client("healthlake").list_fhir_import_jobs
method.
boto3 documentation
# list_fhir_import_jobs method definition
await def list_fhir_import_jobs(
self,
*,
DatastoreId: str,
NextToken: str = ...,
MaxResults: int = ...,
JobName: str = ...,
JobStatus: JobStatusType = ..., # (1)
SubmittedBefore: Union[datetime, str] = ...,
SubmittedAfter: Union[datetime, str] = ...,
) -> ListFHIRImportJobsResponseTypeDef: # (2)
...
# list_fhir_import_jobs method usage example with argument unpacking
kwargs: ListFHIRImportJobsRequestRequestTypeDef = { # (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 session.create_client("healthlake").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
start_fhir_export_job#
Begins a FHIR export job.
Type annotations and code completion for session.create_client("healthlake").start_fhir_export_job
method.
boto3 documentation
# start_fhir_export_job method definition
await def start_fhir_export_job(
self,
*,
OutputDataConfig: OutputDataConfigTypeDef, # (1)
DatastoreId: str,
DataAccessRoleArn: str,
ClientToken: str,
JobName: str = ...,
) -> StartFHIRExportJobResponseTypeDef: # (2)
...
# start_fhir_export_job method usage example with argument unpacking
kwargs: StartFHIRExportJobRequestRequestTypeDef = { # (1)
"OutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
"ClientToken": ...,
}
parent.start_fhir_export_job(**kwargs)
start_fhir_import_job#
Begins a FHIR Import job.
Type annotations and code completion for session.create_client("healthlake").start_fhir_import_job
method.
boto3 documentation
# start_fhir_import_job method definition
await def start_fhir_import_job(
self,
*,
InputDataConfig: InputDataConfigTypeDef, # (1)
JobOutputDataConfig: OutputDataConfigTypeDef, # (2)
DatastoreId: str,
DataAccessRoleArn: str,
ClientToken: str,
JobName: str = ...,
) -> StartFHIRImportJobResponseTypeDef: # (3)
...
# start_fhir_import_job method usage example with argument unpacking
kwargs: StartFHIRImportJobRequestRequestTypeDef = { # (1)
"InputDataConfig": ...,
"JobOutputDataConfig": ...,
"DatastoreId": ...,
"DataAccessRoleArn": ...,
"ClientToken": ...,
}
parent.start_fhir_import_job(**kwargs)
tag_resource#
Adds a user specified key and value tag to a data store.
Type annotations and code completion for session.create_client("healthlake").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from a data store.
Type annotations and code completion for session.create_client("healthlake").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("healthlake").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> HealthLakeClient:
...
__aexit__#
Type annotations and code completion for session.create_client("healthlake").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...