Skip to content

HealthLake module#

Index > HealthLake

Auto-generated documentation for HealthLake type annotations stubs module types-boto3-healthlake.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.43.49' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add HealthLake service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and HealthLake.

From PyPI with pip#

Install types-boto3 for HealthLake service.

# install with boto3 type annotations
python -m pip install 'types-boto3[healthlake]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[healthlake]'

# standalone installation
python -m pip install types-boto3-healthlake

How to uninstall#

python -m pip uninstall -y types-boto3-healthlake

Usage#

Code samples can be found in Examples.

HealthLakeClient#

Type annotations and code completion for boto3.client("healthlake") as HealthLakeClient boto3 documentation

# HealthLakeClient usage example

from boto3.session import Session

from types_boto3_healthlake.client import HealthLakeClient

def get_client() -> HealthLakeClient:
    return Session().client("healthlake")

Paginators#

Type annotations and code completion for paginators from boto3.client("healthlake").get_paginator("...").

# ListDataTransformationJobsPaginator usage example

from boto3.session import Session

from types_boto3_healthlake.paginator import ListDataTransformationJobsPaginator

def get_list_data_transformation_jobs_paginator() -> ListDataTransformationJobsPaginator:
    return Session().client("healthlake").get_paginator("list_data_transformation_jobs"))

Waiters#

Type annotations and code completion for waiters from boto3.client("healthlake").get_waiter("...").

# DataTransformationJobCompletedWaiter usage example

from boto3.session import Session

from types_boto3_healthlake.waiter import DataTransformationJobCompletedWaiter

def get_data_transformation_job_completed_waiter() -> DataTransformationJobCompletedWaiter:
    return Session().client("healthlake").get_waiter("data_transformation_job_completed")

Literals#

Type annotations for literals used in methods and schema.

# AgentInputMessageTypeType usage example

from types_boto3_healthlake.literals import AgentInputMessageTypeType

def get_value() -> AgentInputMessageTypeType:
    return "confirmation_response"

Type definitions#

Type annotations for type definitions used in methods and schema.