ConnectHealth module#
Index > ConnectHealth
Auto-generated documentation for ConnectHealth type annotations stubs module mypy-boto3-connecthealth.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3 package locally with mypy-boto3-builder.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.42.62' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
ConnectHealthservice. - 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 ConnectHealth.
From PyPI with pip#
Install boto3-stubs for ConnectHealth service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[connecthealth]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[connecthealth]'
# standalone installation
python -m pip install mypy-boto3-connecthealth
How to uninstall#
python -m pip uninstall -y mypy-boto3-connecthealth
Usage#
Code samples can be found in Examples.
ConnectHealthClient#
Type annotations and code completion for boto3.client("connecthealth") as ConnectHealthClient
boto3 documentation
# ConnectHealthClient usage example
from boto3.session import Session
from mypy_boto3_connecthealth.client import ConnectHealthClient
def get_client() -> ConnectHealthClient:
return Session().client("connecthealth")
Paginators#
Type annotations and code completion for paginators
from boto3.client("connecthealth").get_paginator("...").
# ListDomainsPaginator usage example
from boto3.session import Session
from mypy_boto3_connecthealth.paginator import ListDomainsPaginator
def get_list_domains_paginator() -> ListDomainsPaginator:
return Session().client("connecthealth").get_paginator("list_domains"))
Literals#
Type annotations for literals used in methods and schema.
# CustomTemplateBaseType usage example
from mypy_boto3_connecthealth.literals import CustomTemplateBaseType
def get_value() -> CustomTemplateBaseType:
return "BEHAVIORAL_SOAP"
- CustomTemplateBaseType
- DomainStatusType
- EncryptionTypeType
- InsightsTypeType
- JobStatusType
- ListDomainsPaginatorName
- ListSubscriptionsPaginatorName
- ManagedNoteTemplateType
- MedicalScribeLanguageCodeType
- MedicalScribeMediaEncodingType
- MedicalScribeParticipantRoleType
- MedicalScribeSessionControlEventTypeType
- MedicalScribeStreamStatusType
- PostStreamArtifactGenerationStatusType
- PronounsType
- ProviderRoleType
- SpecialtyType
- SubscriptionStatusType
- ConnectHealthServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActivateSubscriptionInputTypeDef
- ResponseMetadataTypeDef
- SubscriptionDescriptionTypeDef
- ArtifactDetailsTypeDef
- BlobTypeDef
- CreateWebAppConfigurationTypeDef
- EncryptionContextTypeDef
- WebAppConfigurationTypeDef
- CreateSubscriptionInputTypeDef
- CustomTemplateResponseTypeDef
- TemplateSectionInstructionTypeDef
- DeactivateSubscriptionInputTypeDef
- DeleteDomainInputTypeDef
- DomainSummaryTypeDef
- EncounterContextTypeDef
- FHIRServerTypeDef
- GetDomainInputTypeDef
- GetMedicalScribeListeningSessionInputTypeDef
- GetPatientInsightsJobRequestTypeDef
- InsightsContextTypeDef
- InsightsOutputTypeDef
- OutputDataConfigTypeDef
- PatientInsightsEncounterContextTypeDef
- PatientInsightsPatientContextTypeDef
- UserContextTypeDef
- GetSubscriptionInputTypeDef
- S3SourceTypeDef
- InternalServerExceptionTypeDef
- PaginatorConfigTypeDef
- ListDomainsInputTypeDef
- ListSubscriptionsInputTypeDef
- ListTagsForResourceInputTypeDef
- ManagedTemplateResponseTypeDef
- ManagedTemplateTypeDef
- MedicalScribeChannelDefinitionTypeDef
- MedicalScribeSessionControlEventTypeDef
- ValidationExceptionTypeDef
- MedicalScribeTranscriptSegmentTypeDef
- TagResourceInputTypeDef
- UntagResourceInputTypeDef
- CreateSubscriptionOutputTypeDef
- DeleteDomainOutputTypeDef
- EmptyResponseMetadataTypeDef
- ListTagsForResourceOutputTypeDef
- StartPatientInsightsJobResponseTypeDef
- ActivateSubscriptionOutputTypeDef
- DeactivateSubscriptionOutputTypeDef
- GetSubscriptionOutputTypeDef
- ListSubscriptionsOutputTypeDef
- ClinicalNoteGenerationResultTypeDef
- MedicalScribeAudioEventTypeDef
- CreateDomainInputTypeDef
- CreateDomainOutputTypeDef
- GetDomainOutputTypeDef
- CustomTemplateTypeDef
- ListDomainsOutputTypeDef
- InputDataConfigOutputTypeDef
- InputDataConfigTypeDef
- ListDomainsInputPaginateTypeDef
- ListSubscriptionsInputPaginateTypeDef
- NoteTemplateSettingsResponseTypeDef
- MedicalScribeTranscriptEventTypeDef
- MedicalScribePostStreamActionsResultTypeDef
- NoteTemplateSettingsTypeDef
- GetPatientInsightsJobResponseTypeDef
- InputDataConfigUnionTypeDef
- ClinicalNoteGenerationSettingsResponseTypeDef
- MedicalScribeOutputStreamTypeDef
- ClinicalNoteGenerationSettingsTypeDef
- StartPatientInsightsJobRequestTypeDef
- MedicalScribePostStreamActionSettingsResponseTypeDef
- StartMedicalScribeListeningSessionOutputTypeDef
- MedicalScribePostStreamActionSettingsTypeDef
- MedicalScribeListeningSessionDetailsTypeDef
- MedicalScribeConfigurationEventTypeDef
- GetMedicalScribeListeningSessionOutputTypeDef
- MedicalScribeInputStreamTypeDef
- StartMedicalScribeListeningSessionInputTypeDef