ConnectHealth¶
Installation¶
To install the ConnectHealth client:
Bidirectional streaming¶
This client supports bidirectional event streams, which require the HTTP client from the AWS Common Runtime (CRT). To use this feature, install the package with the awscrt extra:
Then pass an AWSCRTHTTPClient instance as the transport when you resolve the config.
Clients¶
The package provides a synchronous client, ConnectHealthClient, and an asynchronous client, AsyncConnectHealthClient. Both clients use the same models.
Operations that use event streams are available only on AsyncConnectHealthClient. They are marked Async only under Operations.
ConnectHealthClient
¶
ConnectHealthClient(config: ConnectHealthConfig | None = None, plugins: list[Plugin] | None = None)
Bases: Client[ConnectHealthConfig]
Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect. It provides pre-built agents that automate patient engagement workflows and support clinical documentation at the point of care.
You can use the Amazon Connect Health API to programmatically manage domains, configure patient engagement agents, run patient insights jobs, and stream ambient documentation sessions. This API reference describes the available API operations and data types for Amazon Connect Health.
We recommend that you use the AWS SDKs to make programmatic API calls to Amazon Connect Health.
AsyncConnectHealthClient
¶
AsyncConnectHealthClient(config: AsyncConnectHealthConfig | None = None, plugins: list[Plugin] | None = None)
Bases: AsyncClient[AsyncConnectHealthConfig]
Amazon Connect Health is an AI-powered healthcare service built on Amazon Connect. It provides pre-built agents that automate patient engagement workflows and support clinical documentation at the point of care.
You can use the Amazon Connect Health API to programmatically manage domains, configure patient engagement agents, run patient insights jobs, and stream ambient documentation sessions. This API reference describes the available API operations and data types for Amazon Connect Health.
We recommend that you use the AWS SDKs to make programmatic API calls to Amazon Connect Health.
Operations¶
activate_subscriptioncreate_domaincreate_subscriptiondeactivate_subscriptiondelete_domainget_domainget_medical_scribe_listening_sessionget_patient_insights_jobget_subscriptionlist_domainslist_subscriptionslist_tags_for_resourcestart_medical_scribe_listening_sessionAsync onlystart_patient_insights_jobtag_resourceuntag_resource
Configuration¶
ConnectHealthConfig
dataclass
¶
Bases: AwsConfig
ConnectHealth configuration.
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
disable_host_prefix_injection
class-attribute
instance-attribute
¶
disable_host_prefix_injection: bool | None = None
Whether to skip prepending operations' modeled host prefixes to the endpoint host.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.protocols to select the protocol, e.g. protocol=AwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
classmethod
¶
resolve(*, profile: str | None = None, fs: FileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_ConnectHealthConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[ConnectHealthConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
AsyncConnectHealthConfig
dataclass
¶
Bases: AsyncAwsConfig
ConnectHealth configuration (async-resolved).
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
disable_host_prefix_injection
class-attribute
instance-attribute
¶
disable_host_prefix_injection: bool | None = None
Whether to skip prepending operations' modeled host prefixes to the endpoint host.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncConnectHealthConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncConnectHealthConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
ArtifactDetailsClinicalNoteGenerationResultClinicalNoteGenerationSettingsClinicalNoteGenerationSettingsResponseCreateWebAppConfigurationCustomTemplateCustomTemplateResponseDomainSummaryEncounterContextEncryptionContextFHIRServerInputDataConfigInsightsContextInsightsOutputManagedTemplateManagedTemplateResponseMedicalScribeAudioEventMedicalScribeBinaryAudioEventMedicalScribeChannelDefinitionMedicalScribeConfigurationEventMedicalScribeListeningSessionDetailsMedicalScribePostStreamActionSettingsMedicalScribePostStreamActionSettingsResponseMedicalScribePostStreamActionsResultMedicalScribeSessionControlEventMedicalScribeTranscriptEventMedicalScribeTranscriptSegmentOutputDataConfigPatientInsightsEncounterContextPatientInsightsPatientContextS3SourceSubscriptionDescriptionTemplateSectionInstructionUserContextWebAppConfiguration
Dictionaries¶
CreateWebAppConfigurationDictFHIRServerDictInputDataConfigDictInsightsContextDictOutputDataConfigDictPatientInsightsEncounterContextDictPatientInsightsPatientContextDictS3SourceDictUserContextDict
Errors¶
AccessDeniedExceptionConflictExceptionInternalServerExceptionResourceNotFoundExceptionServiceErrorServiceQuotaExceededExceptionThrottlingExceptionValidationException
Unions¶
MedicalScribeInputStreamMedicalScribeOutputStreamNoteTemplateSettingsNoteTemplateSettingsResponse
Enums¶
CustomTemplateBaseDomainStatusEncryptionTypeInsightsTypeJobStatusManagedNoteTemplateMedicalScribeLanguageCodeMedicalScribeMediaEncodingMedicalScribeParticipantRoleMedicalScribeSessionControlEventTypeMedicalScribeStreamStatusPostStreamArtifactGenerationStatusPronounsProviderRoleSpecialtySubscriptionStatus