connecthealth/aws.sdk.kotlin.services.connecthealth/ConnectHealthClient

ConnectHealthClient

interface ConnectHealthClient

Health Agent for healthcare providers and patient engagement

Types

object Companion

class Config

Properties

abstract val config: ConnectHealthClient.Config

ConnectHealthClient's configuration

Functions

activateSubscription

abstract suspend fun activateSubscription(input: ActivateSubscriptionRequest): ActivateSubscriptionResponse

Activates a Subscription to enable billing for a user.

abstract suspend fun createDomain(input: CreateDomainRequest): CreateDomainResponse

Creates a new Domain for managing HealthAgent resources.

createSubscription

abstract suspend fun createSubscription(input: CreateSubscriptionRequest): CreateSubscriptionResponse

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

deactivateSubscription

abstract suspend fun deactivateSubscription(input: DeactivateSubscriptionRequest): DeactivateSubscriptionResponse

Deactivates a Subscription to stop billing for a user.

abstract suspend fun deleteDomain(input: DeleteDomainRequest): DeleteDomainResponse

Deletes a Domain and all associated resources.

abstract suspend fun getDomain(input: GetDomainRequest): GetDomainResponse

Retrieves information about a Domain.

getMedicalScribeListeningSession

abstract suspend fun getMedicalScribeListeningSession(input: GetMedicalScribeListeningSessionRequest): GetMedicalScribeListeningSessionResponse

Retrieves details about an existing Medical Scribe listening session

getPatientInsightsJob

abstract suspend fun getPatientInsightsJob(input: GetPatientInsightsJobRequest): GetPatientInsightsJobResponse

Get details of a started patient insights job.

getSubscription

abstract suspend fun getSubscription(input: GetSubscriptionRequest): GetSubscriptionResponse

Retrieves information about a Subscription.

abstract suspend fun listDomains(input: ListDomainsRequest = ListDomainsRequest { }): ListDomainsResponse

Lists Domains for a given account.

listSubscriptions

abstract suspend fun listSubscriptions(input: ListSubscriptionsRequest): ListSubscriptionsResponse

Lists all Subscriptions within a Domain.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags associated with the specified resource

startMedicalScribeListeningSession

abstract suspend fun <T> startMedicalScribeListeningSession(input: StartMedicalScribeListeningSessionRequest, block: suspend (StartMedicalScribeListeningSessionResponse) -> T): T

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

startPatientInsightsJob

abstract suspend fun startPatientInsightsJob(input: StartPatientInsightsJobRequest): StartPatientInsightsJobResponse

Starts a new patient insights job.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Associates the specified tags with the specified resource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the specified resource

Inherited functions

activateSubscription

inline suspend fun ConnectHealthClient.activateSubscription(crossinline block: ActivateSubscriptionRequest.Builder.() -> Unit): ActivateSubscriptionResponse

Activates a Subscription to enable billing for a user.

inline suspend fun ConnectHealthClient.createDomain(crossinline block: CreateDomainRequest.Builder.() -> Unit): CreateDomainResponse

Creates a new Domain for managing HealthAgent resources.

createSubscription

inline suspend fun ConnectHealthClient.createSubscription(crossinline block: CreateSubscriptionRequest.Builder.() -> Unit): CreateSubscriptionResponse

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

deactivateSubscription

inline suspend fun ConnectHealthClient.deactivateSubscription(crossinline block: DeactivateSubscriptionRequest.Builder.() -> Unit): DeactivateSubscriptionResponse

Deactivates a Subscription to stop billing for a user.

inline suspend fun ConnectHealthClient.deleteDomain(crossinline block: DeleteDomainRequest.Builder.() -> Unit): DeleteDomainResponse

Deletes a Domain and all associated resources.

inline suspend fun ConnectHealthClient.getDomain(crossinline block: GetDomainRequest.Builder.() -> Unit): GetDomainResponse

Retrieves information about a Domain.

getMedicalScribeListeningSession

inline suspend fun ConnectHealthClient.getMedicalScribeListeningSession(crossinline block: GetMedicalScribeListeningSessionRequest.Builder.() -> Unit): GetMedicalScribeListeningSessionResponse

Retrieves details about an existing Medical Scribe listening session

getPatientInsightsJob

inline suspend fun ConnectHealthClient.getPatientInsightsJob(crossinline block: GetPatientInsightsJobRequest.Builder.() -> Unit): GetPatientInsightsJobResponse

Get details of a started patient insights job.

getSubscription

inline suspend fun ConnectHealthClient.getSubscription(crossinline block: GetSubscriptionRequest.Builder.() -> Unit): GetSubscriptionResponse

Retrieves information about a Subscription.

inline suspend fun ConnectHealthClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

Lists Domains for a given account.

listDomainsPaginated

fun ConnectHealthClient.listDomainsPaginated(initialRequest: ListDomainsRequest = ListDomainsRequest { }): Flow<ListDomainsResponse>

fun ConnectHealthClient.listDomainsPaginated(block: ListDomainsRequest.Builder.() -> Unit): Flow<ListDomainsResponse>

Paginate over ListDomainsResponse results.

listSubscriptions

inline suspend fun ConnectHealthClient.listSubscriptions(crossinline block: ListSubscriptionsRequest.Builder.() -> Unit): ListSubscriptionsResponse

Lists all Subscriptions within a Domain.

listSubscriptionsPaginated

fun ConnectHealthClient.listSubscriptionsPaginated(initialRequest: ListSubscriptionsRequest): Flow<ListSubscriptionsResponse>

fun ConnectHealthClient.listSubscriptionsPaginated(block: ListSubscriptionsRequest.Builder.() -> Unit): Flow<ListSubscriptionsResponse>

Paginate over ListSubscriptionsResponse results.

listTagsForResource

inline suspend fun ConnectHealthClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags associated with the specified resource

startPatientInsightsJob

inline suspend fun ConnectHealthClient.startPatientInsightsJob(crossinline block: StartPatientInsightsJobRequest.Builder.() -> Unit): StartPatientInsightsJobResponse

Starts a new patient insights job.

inline suspend fun ConnectHealthClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates the specified tags with the specified resource

inline suspend fun ConnectHealthClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified tags from the specified resource

fun ConnectHealthClient.withConfig(block: ConnectHealthClient.Config.Builder.() -> Unit): ConnectHealthClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.