Implementation for accessing ConnectHealth
Service client instances are thread-safe and can be shared across multiple threads. For a given service configuration, it is recommended to reuse a client instance for the lifetime of your application.
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.
In this article ▶
Inheritance Hierarchy
Namespace: Amazon.ConnectHealth
Assembly: AWSSDK.ConnectHealth.dll
Version: 3.x.y.z
Syntax
public class AmazonConnectHealthClient : AmazonServiceClient IAmazonConnectHealth, IAmazonService, IDisposable
The AmazonConnectHealthClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonConnectHealthClient() |
Constructs AmazonConnectHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonConnectHealthClient(RegionEndpoint) |
Constructs AmazonConnectHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonConnectHealthClient(AmazonConnectHealthConfig) |
Constructs AmazonConnectHealthClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonConnectHealthClient(AWSCredentials) |
Constructs AmazonConnectHealthClient with AWS Credentials |
|
|
AmazonConnectHealthClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonConnectHealthClient with AWS Credentials |
|
|
AmazonConnectHealthClient(AWSCredentials, AmazonConnectHealthConfig) |
Constructs AmazonConnectHealthClient with AWS Credentials and an AmazonConnectHealthClient Configuration object. |
|
|
AmazonConnectHealthClient(string, string) |
Constructs AmazonConnectHealthClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonConnectHealthClient(string, string, RegionEndpoint) |
Constructs AmazonConnectHealthClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonConnectHealthClient(string, string, AmazonConnectHealthConfig) |
Constructs AmazonConnectHealthClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectHealthClient Configuration object. |
|
|
AmazonConnectHealthClient(string, string, string) |
Constructs AmazonConnectHealthClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonConnectHealthClient(string, string, string, RegionEndpoint) |
Constructs AmazonConnectHealthClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonConnectHealthClient(string, string, string, AmazonConnectHealthConfig) |
Constructs AmazonConnectHealthClient with AWS Access Key ID, AWS Secret Key and an AmazonConnectHealthClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.ConnectHealth.Model.IConnectHealthPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
ActivateSubscription(ActivateSubscriptionRequest) |
Activates a Subscription to enable billing for a user. |
|
|
ActivateSubscriptionAsync(ActivateSubscriptionRequest, CancellationToken) |
Activates a Subscription to enable billing for a user. |
|
|
CreateDomain(CreateDomainRequest) |
Creates a new Domain for managing HealthAgent resources. |
|
|
CreateDomainAsync(CreateDomainRequest, CancellationToken) |
Creates a new Domain for managing HealthAgent resources. |
|
|
CreateSubscription(CreateSubscriptionRequest) |
Creates a new Subscription within a Domain for billing and user management. |
|
|
CreateSubscriptionAsync(CreateSubscriptionRequest, CancellationToken) |
Creates a new Subscription within a Domain for billing and user management. |
|
|
DeactivateSubscription(DeactivateSubscriptionRequest) |
Deactivates a Subscription to stop billing for a user. |
|
|
DeactivateSubscriptionAsync(DeactivateSubscriptionRequest, CancellationToken) |
Deactivates a Subscription to stop billing for a user. |
|
|
DeleteDomain(DeleteDomainRequest) |
Deletes a Domain and all associated resources. |
|
|
DeleteDomainAsync(DeleteDomainRequest, CancellationToken) |
Deletes a Domain and all associated resources. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetDomain(GetDomainRequest) |
Retrieves information about a Domain. |
|
|
GetDomainAsync(GetDomainRequest, CancellationToken) |
Retrieves information about a Domain. |
|
|
GetMedicalScribeListeningSession(GetMedicalScribeListeningSessionRequest) |
Retrieves details about an existing Medical Scribe listening session |
|
|
GetMedicalScribeListeningSessionAsync(GetMedicalScribeListeningSessionRequest, CancellationToken) |
Retrieves details about an existing Medical Scribe listening session |
|
|
GetPatientInsightsJob(GetPatientInsightsJobRequest) |
Get details of a started patient insights job. |
|
|
GetPatientInsightsJobAsync(GetPatientInsightsJobRequest, CancellationToken) |
Get details of a started patient insights job. |
|
|
GetSubscription(GetSubscriptionRequest) |
Retrieves information about a Subscription. |
|
|
GetSubscriptionAsync(GetSubscriptionRequest, CancellationToken) |
Retrieves information about a Subscription. |
|
|
ListDomains(ListDomainsRequest) |
Lists Domains for a given account. |
|
|
ListDomainsAsync(ListDomainsRequest, CancellationToken) |
Lists Domains for a given account. |
|
|
ListSubscriptions(ListSubscriptionsRequest) |
Lists all Subscriptions within a Domain. |
|
|
ListSubscriptionsAsync(ListSubscriptionsRequest, CancellationToken) |
Lists all Subscriptions within a Domain. |
|
|
ListTagsForResource(ListTagsForResourceRequest) |
Lists the tags associated with the specified resource |
|
|
ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken) |
Lists the tags associated with the specified resource |
|
|
StartMedicalScribeListeningSessionAsync(StartMedicalScribeListeningSessionRequest, CancellationToken) |
Starts a new Medical Scribe listening session for real-time audio transcription |
|
|
StartPatientInsightsJob(StartPatientInsightsJobRequest) |
Starts a new patient insights job. |
|
|
StartPatientInsightsJobAsync(StartPatientInsightsJobRequest, CancellationToken) |
Starts a new patient insights job. |
|
|
TagResource(TagResourceRequest) |
Associates the specified tags with the specified resource |
|
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Associates the specified tags with the specified resource |
|
|
UntagResource(UntagResourceRequest) |
Removes the specified tags from the specified resource |
|
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes the specified tags from the specified resource |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer