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.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 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

# can_paginate 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

# close 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

# 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)
    ...

1. See FHIRVersionType
2. See SseConfigurationTypeDef
3. See PreloadDataConfigTypeDef
4. See TagTypeDef
5. See IdentityProviderConfigurationTypeDef
6. See CreateFHIRDatastoreResponseTypeDef

# create_fhir_datastore method usage example with argument unpacking

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

# delete_fhir_datastore method definition

def delete_fhir_datastore(
    self,
    *,
    DatastoreId: str,
) -> DeleteFHIRDatastoreResponseTypeDef:  # (1)
    ...

1. See DeleteFHIRDatastoreResponseTypeDef

# delete_fhir_datastore method usage example with argument unpacking

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, when the data store was created, data store type version, and the data store's endpoint.

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)
    ...

1. See DescribeFHIRDatastoreResponseTypeDef

# describe_fhir_datastore method usage example with argument unpacking

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

# describe_fhir_export_job method definition

def describe_fhir_export_job(
    self,
    *,
    DatastoreId: str,
    JobId: str,
) -> DescribeFHIRExportJobResponseTypeDef:  # (1)
    ...

1. See DescribeFHIRExportJobResponseTypeDef

# describe_fhir_export_job method usage example with argument unpacking

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

# describe_fhir_import_job method definition

def describe_fhir_import_job(
    self,
    *,
    DatastoreId: str,
    JobId: str,
) -> DescribeFHIRImportJobResponseTypeDef:  # (1)
    ...

1. See DescribeFHIRImportJobResponseTypeDef

# describe_fhir_import_job method usage example with argument unpacking

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.