Skip to content

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

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.

Usage example
client = boto3.client("healthlake")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_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 boto3.client("healthlake").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("healthlake").close method. boto3 documentation

Method definition
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 boto3.client("healthlake").create_fhir_datastore method. boto3 documentation

Method definition
def create_fhir_datastore(
    self,
    *,
    DatastoreTypeVersion: FHIRVersionType,  # (1)
    DatastoreName: str = ...,
    SseConfiguration: SseConfigurationTypeDef = ...,  # (2)
    PreloadDataConfig: PreloadDataConfigTypeDef = ...,  # (3)
    ClientToken: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateFHIRDatastoreResponseTypeDef:  # (5)
    ...
  1. See FHIRVersionType
  2. See SseConfigurationTypeDef
  3. See PreloadDataConfigTypeDef
  4. See TagTypeDef
  5. See CreateFHIRDatastoreResponseTypeDef
Usage example with kwargs
kwargs: CreateFHIRDatastoreRequestRequestTypeDef = {  # (1)
    "DatastoreTypeVersion": ...,
}

parent.create_fhir_datastore(**kwargs)
  1. See CreateFHIRDatastoreRequestRequestTypeDef

delete_fhir_datastore

Deletes a Data Store.

Type annotations and code completion for boto3.client("healthlake").delete_fhir_datastore method. boto3 documentation

Method definition
def delete_fhir_datastore(
    self,
    *,
    DatastoreId: str = ...,
) -> DeleteFHIRDatastoreResponseTypeDef:  # (1)
    ...
  1. See DeleteFHIRDatastoreResponseTypeDef
Usage example with kwargs
kwargs: DeleteFHIRDatastoreRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
}

parent.delete_fhir_datastore(**kwargs)
  1. See DeleteFHIRDatastoreRequestRequestTypeDef

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, created at, Data Store type version, and Data Store endpoint.

Type annotations and code completion for boto3.client("healthlake").describe_fhir_datastore method. boto3 documentation

Method definition
def describe_fhir_datastore(
    self,
    *,
    DatastoreId: str = ...,
) -> DescribeFHIRDatastoreResponseTypeDef:  # (1)
    ...
  1. See DescribeFHIRDatastoreResponseTypeDef
Usage example with kwargs
kwargs: DescribeFHIRDatastoreRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
}

parent.describe_fhir_datastore(**kwargs)
  1. See DescribeFHIRDatastoreRequestRequestTypeDef

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 boto3.client("healthlake").describe_fhir_export_job method. boto3 documentation

Method definition
def describe_fhir_export_job(
    self,
    *,
    DatastoreId: str,
    JobId: str,
) -> DescribeFHIRExportJobResponseTypeDef:  # (1)
    ...
  1. See DescribeFHIRExportJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeFHIRExportJobRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
    "JobId": ...,
}

parent.describe_fhir_export_job(**kwargs)
  1. See DescribeFHIRExportJobRequestRequestTypeDef

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 boto3.client("healthlake").describe_fhir_import_job method. boto3 documentation

Method definition
def describe_fhir_import_job(
    self,
    *,
    DatastoreId: str,
    JobId: str,
) -> DescribeFHIRImportJobResponseTypeDef:  # (1)
    ...
  1. See DescribeFHIRImportJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeFHIRImportJobRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
    "JobId": ...,
}

parent.describe_fhir_import_job(**kwargs)
  1. See DescribeFHIRImportJobRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("healthlake").generate_presigned_url method. boto3 documentation

Method definition
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 boto3.client("healthlake").list_fhir_datastores method. boto3 documentation

Method definition
def list_fhir_datastores(
    self,
    *,
    Filter: DatastoreFilterTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFHIRDatastoresResponseTypeDef:  # (2)
    ...
  1. See DatastoreFilterTypeDef
  2. See ListFHIRDatastoresResponseTypeDef
Usage example with kwargs
kwargs: ListFHIRDatastoresRequestRequestTypeDef = {  # (1)
    "Filter": ...,
}

parent.list_fhir_datastores(**kwargs)
  1. See ListFHIRDatastoresRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See JobStatusType
  2. See ListFHIRExportJobsResponseTypeDef
Usage example with kwargs
kwargs: ListFHIRExportJobsRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
}

parent.list_fhir_export_jobs(**kwargs)
  1. See ListFHIRExportJobsRequestRequestTypeDef

list_fhir_import_jobs

Lists 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

Method definition
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)
    ...
  1. See JobStatusType
  2. See ListFHIRImportJobsResponseTypeDef
Usage example with kwargs
kwargs: ListFHIRImportJobsRequestRequestTypeDef = {  # (1)
    "DatastoreId": ...,
}

parent.list_fhir_import_jobs(**kwargs)
  1. See ListFHIRImportJobsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_fhir_export_job

Begins a FHIR export job.

Type annotations and code completion for boto3.client("healthlake").start_fhir_export_job method. boto3 documentation

Method definition
def start_fhir_export_job(
    self,
    *,
    OutputDataConfig: OutputDataConfigTypeDef,  # (1)
    DatastoreId: str,
    DataAccessRoleArn: str,
    ClientToken: str,
    JobName: str = ...,
) -> StartFHIRExportJobResponseTypeDef:  # (2)
    ...
  1. See OutputDataConfigTypeDef
  2. See StartFHIRExportJobResponseTypeDef
Usage example with kwargs
kwargs: StartFHIRExportJobRequestRequestTypeDef = {  # (1)
    "OutputDataConfig": ...,
    "DatastoreId": ...,
    "DataAccessRoleArn": ...,
    "ClientToken": ...,
}

parent.start_fhir_export_job(**kwargs)
  1. See StartFHIRExportJobRequestRequestTypeDef

start_fhir_import_job

Begins a FHIR Import job.

Type annotations and code completion for boto3.client("healthlake").start_fhir_import_job method. boto3 documentation

Method definition
def start_fhir_import_job(
    self,
    *,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    JobOutputDataConfig: OutputDataConfigTypeDef,  # (2)
    DatastoreId: str,
    DataAccessRoleArn: str,
    ClientToken: str,
    JobName: str = ...,
) -> StartFHIRImportJobResponseTypeDef:  # (3)
    ...
  1. See InputDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See StartFHIRImportJobResponseTypeDef
Usage example with kwargs
kwargs: StartFHIRImportJobRequestRequestTypeDef = {  # (1)
    "InputDataConfig": ...,
    "JobOutputDataConfig": ...,
    "DatastoreId": ...,
    "DataAccessRoleArn": ...,
    "ClientToken": ...,
}

parent.start_fhir_import_job(**kwargs)
  1. See StartFHIRImportJobRequestRequestTypeDef

tag_resource

Adds 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

Method definition
def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from a Data Store.

Type annotations and code completion for boto3.client("healthlake").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef