Skip to content

ConnectHealthClient#

Index > ConnectHealth > ConnectHealthClient

Auto-generated documentation for ConnectHealth type annotations stubs module mypy-boto3-connecthealth.

ConnectHealthClient#

Type annotations and code completion for boto3.client("connecthealth"). boto3 documentation

# ConnectHealthClient usage example

from boto3.session import Session
from mypy_boto3_connecthealth.client import ConnectHealthClient

def get_connecthealth_client() -> ConnectHealthClient:
    return Session().client("connecthealth")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("connecthealth").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("connecthealth")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_connecthealth.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("connecthealth").can_paginate method. boto3 documentation

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

activate_subscription#

Activates a Subscription to enable billing for a user.

Type annotations and code completion for boto3.client("connecthealth").activate_subscription method. boto3 documentation

# activate_subscription method definition

def activate_subscription(
    self,
    *,
    domainId: str,
    subscriptionId: str,
) -> ActivateSubscriptionOutputTypeDef:  # (1)
    ...
  1. See ActivateSubscriptionOutputTypeDef
# activate_subscription method usage example with argument unpacking

kwargs: ActivateSubscriptionInputTypeDef = {  # (1)
    "domainId": ...,
    "subscriptionId": ...,
}

parent.activate_subscription(**kwargs)
  1. See ActivateSubscriptionInputTypeDef

create_domain#

Creates a new Domain for managing HealthAgent resources.

Type annotations and code completion for boto3.client("connecthealth").create_domain method. boto3 documentation

# create_domain method definition

def create_domain(
    self,
    *,
    name: str,
    kmsKeyArn: str = ...,
    webAppSetupConfiguration: CreateWebAppConfigurationTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateDomainOutputTypeDef:  # (2)
    ...
  1. See CreateWebAppConfigurationTypeDef
  2. See CreateDomainOutputTypeDef
# create_domain method usage example with argument unpacking

kwargs: CreateDomainInputTypeDef = {  # (1)
    "name": ...,
}

parent.create_domain(**kwargs)
  1. See CreateDomainInputTypeDef

create_subscription#

Creates a new Subscription within a Domain for billing and user management.

Type annotations and code completion for boto3.client("connecthealth").create_subscription method. boto3 documentation

# create_subscription method definition

def create_subscription(
    self,
    *,
    domainId: str,
) -> CreateSubscriptionOutputTypeDef:  # (1)
    ...
  1. See CreateSubscriptionOutputTypeDef
# create_subscription method usage example with argument unpacking

kwargs: CreateSubscriptionInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.create_subscription(**kwargs)
  1. See CreateSubscriptionInputTypeDef

deactivate_subscription#

Deactivates a Subscription to stop billing for a user.

Type annotations and code completion for boto3.client("connecthealth").deactivate_subscription method. boto3 documentation

# deactivate_subscription method definition

def deactivate_subscription(
    self,
    *,
    domainId: str,
    subscriptionId: str,
) -> DeactivateSubscriptionOutputTypeDef:  # (1)
    ...
  1. See DeactivateSubscriptionOutputTypeDef
# deactivate_subscription method usage example with argument unpacking

kwargs: DeactivateSubscriptionInputTypeDef = {  # (1)
    "domainId": ...,
    "subscriptionId": ...,
}

parent.deactivate_subscription(**kwargs)
  1. See DeactivateSubscriptionInputTypeDef

delete_domain#

Deletes a Domain and all associated resources.

Type annotations and code completion for boto3.client("connecthealth").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    domainId: str,
) -> DeleteDomainOutputTypeDef:  # (1)
    ...
  1. See DeleteDomainOutputTypeDef
# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.delete_domain(**kwargs)
  1. See DeleteDomainInputTypeDef

get_domain#

Retrieves information about a Domain.

Type annotations and code completion for boto3.client("connecthealth").get_domain method. boto3 documentation

# get_domain method definition

def get_domain(
    self,
    *,
    domainId: str,
) -> GetDomainOutputTypeDef:  # (1)
    ...
  1. See GetDomainOutputTypeDef
# get_domain method usage example with argument unpacking

kwargs: GetDomainInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.get_domain(**kwargs)
  1. See GetDomainInputTypeDef

get_medical_scribe_listening_session#

Retrieves details about an existing Medical Scribe listening session.

Type annotations and code completion for boto3.client("connecthealth").get_medical_scribe_listening_session method. boto3 documentation

# get_medical_scribe_listening_session method definition

def get_medical_scribe_listening_session(
    self,
    *,
    sessionId: str,
    domainId: str,
    subscriptionId: str,
) -> GetMedicalScribeListeningSessionOutputTypeDef:  # (1)
    ...
  1. See GetMedicalScribeListeningSessionOutputTypeDef
# get_medical_scribe_listening_session method usage example with argument unpacking

kwargs: GetMedicalScribeListeningSessionInputTypeDef = {  # (1)
    "sessionId": ...,
    "domainId": ...,
    "subscriptionId": ...,
}

parent.get_medical_scribe_listening_session(**kwargs)
  1. See GetMedicalScribeListeningSessionInputTypeDef

get_patient_insights_job#

Get details of a started patient insights job.

Type annotations and code completion for boto3.client("connecthealth").get_patient_insights_job method. boto3 documentation

# get_patient_insights_job method definition

def get_patient_insights_job(
    self,
    *,
    domainId: str,
    jobId: str,
) -> GetPatientInsightsJobResponseTypeDef:  # (1)
    ...
  1. See GetPatientInsightsJobResponseTypeDef
# get_patient_insights_job method usage example with argument unpacking

kwargs: GetPatientInsightsJobRequestTypeDef = {  # (1)
    "domainId": ...,
    "jobId": ...,
}

parent.get_patient_insights_job(**kwargs)
  1. See GetPatientInsightsJobRequestTypeDef

get_subscription#

Retrieves information about a Subscription.

Type annotations and code completion for boto3.client("connecthealth").get_subscription method. boto3 documentation

# get_subscription method definition

def get_subscription(
    self,
    *,
    domainId: str,
    subscriptionId: str,
) -> GetSubscriptionOutputTypeDef:  # (1)
    ...
  1. See GetSubscriptionOutputTypeDef
# get_subscription method usage example with argument unpacking

kwargs: GetSubscriptionInputTypeDef = {  # (1)
    "domainId": ...,
    "subscriptionId": ...,
}

parent.get_subscription(**kwargs)
  1. See GetSubscriptionInputTypeDef

list_domains#

Lists Domains for a given account.

Type annotations and code completion for boto3.client("connecthealth").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    status: DomainStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDomainsOutputTypeDef:  # (2)
    ...
  1. See DomainStatusType
  2. See ListDomainsOutputTypeDef
# list_domains method usage example with argument unpacking

kwargs: ListDomainsInputTypeDef = {  # (1)
    "status": ...,
}

parent.list_domains(**kwargs)
  1. See ListDomainsInputTypeDef

list_subscriptions#

Lists all Subscriptions within a Domain.

Type annotations and code completion for boto3.client("connecthealth").list_subscriptions method. boto3 documentation

# list_subscriptions method definition

def list_subscriptions(
    self,
    *,
    domainId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSubscriptionsOutputTypeDef:  # (1)
    ...
  1. See ListSubscriptionsOutputTypeDef
# list_subscriptions method usage example with argument unpacking

kwargs: ListSubscriptionsInputTypeDef = {  # (1)
    "domainId": ...,
}

parent.list_subscriptions(**kwargs)
  1. See ListSubscriptionsInputTypeDef

list_tags_for_resource#

Lists the tags associated with the specified resource.

Type annotations and code completion for boto3.client("connecthealth").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

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

start_medical_scribe_listening_session#

Starts a new Medical Scribe listening session for real-time audio transcription.

Type annotations and code completion for boto3.client("connecthealth").start_medical_scribe_listening_session method. boto3 documentation

# start_medical_scribe_listening_session method definition

def start_medical_scribe_listening_session(
    self,
    *,
    sessionId: str,
    domainId: str,
    subscriptionId: str,
    languageCode: MedicalScribeLanguageCodeType,  # (1)
    mediaSampleRateHertz: int,
    mediaEncoding: MedicalScribeMediaEncodingType,  # (2)
    inputStream: botocore.eventstream.EventStream[MedicalScribeInputStreamTypeDef] = ...,  # (3)
) -> StartMedicalScribeListeningSessionOutputTypeDef:  # (4)
    ...
  1. See MedicalScribeLanguageCodeType
  2. See MedicalScribeMediaEncodingType
  3. See EventStream[MedicalScribeInputStreamTypeDef]
  4. See StartMedicalScribeListeningSessionOutputTypeDef
# start_medical_scribe_listening_session method usage example with argument unpacking

kwargs: StartMedicalScribeListeningSessionInputTypeDef = {  # (1)
    "sessionId": ...,
    "domainId": ...,
    "subscriptionId": ...,
    "languageCode": ...,
    "mediaSampleRateHertz": ...,
    "mediaEncoding": ...,
}

parent.start_medical_scribe_listening_session(**kwargs)
  1. See StartMedicalScribeListeningSessionInputTypeDef

start_patient_insights_job#

Starts a new patient insights job.

Type annotations and code completion for boto3.client("connecthealth").start_patient_insights_job method. boto3 documentation

# start_patient_insights_job method definition

def start_patient_insights_job(
    self,
    *,
    domainId: str,
    patientContext: PatientInsightsPatientContextTypeDef,  # (1)
    insightsContext: InsightsContextTypeDef,  # (2)
    encounterContext: PatientInsightsEncounterContextTypeDef,  # (3)
    userContext: UserContextTypeDef,  # (4)
    inputDataConfig: InputDataConfigUnionTypeDef,  # (5)
    outputDataConfig: OutputDataConfigTypeDef,  # (6)
    clientToken: str = ...,
) -> StartPatientInsightsJobResponseTypeDef:  # (7)
    ...
  1. See PatientInsightsPatientContextTypeDef
  2. See InsightsContextTypeDef
  3. See PatientInsightsEncounterContextTypeDef
  4. See UserContextTypeDef
  5. See InputDataConfigUnionTypeDef
  6. See OutputDataConfigTypeDef
  7. See StartPatientInsightsJobResponseTypeDef
# start_patient_insights_job method usage example with argument unpacking

kwargs: StartPatientInsightsJobRequestTypeDef = {  # (1)
    "domainId": ...,
    "patientContext": ...,
    "insightsContext": ...,
    "encounterContext": ...,
    "userContext": ...,
    "inputDataConfig": ...,
    "outputDataConfig": ...,
}

parent.start_patient_insights_job(**kwargs)
  1. See StartPatientInsightsJobRequestTypeDef

tag_resource#

Associates the specified tags with the specified resource.

Type annotations and code completion for boto3.client("connecthealth").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

untag_resource#

Removes the specified tags from the specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

get_paginator#

Type annotations and code completion for boto3.client("connecthealth").get_paginator method with overloads.