Interface ConnectHealthAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Health Agent for healthcare providers and patient engagement
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionactivateSubscription(Consumer<ActivateSubscriptionRequest.Builder> activateSubscriptionRequest) Activates a Subscription to enable billing for a user.activateSubscription(ActivateSubscriptionRequest activateSubscriptionRequest) Activates a Subscription to enable billing for a user.builder()Create a builder that can be used to configure and create aConnectHealthAsyncClient.static ConnectHealthAsyncClientcreate()Create aConnectHealthAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a new Domain for managing HealthAgent resources.default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest) Creates a new Domain for managing HealthAgent resources.createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Creates a new Subscription within a Domain for billing and user management.createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Creates a new Subscription within a Domain for billing and user management.deactivateSubscription(Consumer<DeactivateSubscriptionRequest.Builder> deactivateSubscriptionRequest) Deactivates a Subscription to stop billing for a user.deactivateSubscription(DeactivateSubscriptionRequest deactivateSubscriptionRequest) Deactivates a Subscription to stop billing for a user.default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes a Domain and all associated resources.default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes a Domain and all associated resources.default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) Retrieves information about a Domain.default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest) Retrieves information about a Domain.getMedicalScribeListeningSession(Consumer<GetMedicalScribeListeningSessionRequest.Builder> getMedicalScribeListeningSessionRequest) Retrieves details about an existing Medical Scribe listening sessiongetMedicalScribeListeningSession(GetMedicalScribeListeningSessionRequest getMedicalScribeListeningSessionRequest) Retrieves details about an existing Medical Scribe listening sessiongetPatientInsightsJob(Consumer<GetPatientInsightsJobRequest.Builder> getPatientInsightsJobRequest) Get details of a started patient insights job.getPatientInsightsJob(GetPatientInsightsJobRequest getPatientInsightsJobRequest) Get details of a started patient insights job.default CompletableFuture<GetSubscriptionResponse> getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest) Retrieves information about a Subscription.default CompletableFuture<GetSubscriptionResponse> getSubscription(GetSubscriptionRequest getSubscriptionRequest) Retrieves information about a Subscription.default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Lists Domains for a given account.default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest) Lists Domains for a given account.default ListDomainsPublisherlistDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation.default ListDomainsPublisherlistDomainsPaginator(ListDomainsRequest listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation.listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) Lists all Subscriptions within a Domain.listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) Lists all Subscriptions within a Domain.default ListSubscriptionsPublisherlistSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation.default ListSubscriptionsPublisherlistSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest) This is a variant oflistSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with the specified resourcelistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with the specified resourceThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<Void> startMedicalScribeListeningSession(Consumer<StartMedicalScribeListeningSessionRequest.Builder> startMedicalScribeListeningSessionRequest, org.reactivestreams.Publisher<MedicalScribeInputStream> requestStream, StartMedicalScribeListeningSessionResponseHandler asyncResponseHandler) Starts a new Medical Scribe listening session for real-time audio transcriptiondefault CompletableFuture<Void> startMedicalScribeListeningSession(StartMedicalScribeListeningSessionRequest startMedicalScribeListeningSessionRequest, org.reactivestreams.Publisher<MedicalScribeInputStream> requestStream, StartMedicalScribeListeningSessionResponseHandler asyncResponseHandler) Starts a new Medical Scribe listening session for real-time audio transcriptionstartPatientInsightsJob(Consumer<StartPatientInsightsJobRequest.Builder> startPatientInsightsJobRequest) Starts a new patient insights job.startPatientInsightsJob(StartPatientInsightsJobRequest startPatientInsightsJobRequest) Starts a new patient insights job.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags with the specified resourcedefault CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Associates the specified tags with the specified resourcedefault CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resourcedefault CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resourceMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activateSubscription
default CompletableFuture<ActivateSubscriptionResponse> activateSubscription(ActivateSubscriptionRequest activateSubscriptionRequest) Activates a Subscription to enable billing for a user.
- Parameters:
activateSubscriptionRequest-- Returns:
- A Java Future containing the result of the ActivateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateSubscription
default CompletableFuture<ActivateSubscriptionResponse> activateSubscription(Consumer<ActivateSubscriptionRequest.Builder> activateSubscriptionRequest) Activates a Subscription to enable billing for a user.
This is a convenience which creates an instance of the
ActivateSubscriptionRequest.Builderavoiding the need to create one manually viaActivateSubscriptionRequest.builder()- Parameters:
activateSubscriptionRequest- AConsumerthat will call methods onActivateSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ActivateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest) Creates a new Domain for managing HealthAgent resources.
- Parameters:
createDomainRequest-- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a new Domain for managing HealthAgent resources.
This is a convenience which creates an instance of the
CreateDomainRequest.Builderavoiding the need to create one manually viaCreateDomainRequest.builder()- Parameters:
createDomainRequest- AConsumerthat will call methods onCreateDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSubscription
default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Creates a new Subscription within a Domain for billing and user management.
- Parameters:
createSubscriptionRequest-- Returns:
- A Java Future containing the result of the CreateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSubscription
default CompletableFuture<CreateSubscriptionResponse> createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest) Creates a new Subscription within a Domain for billing and user management.
This is a convenience which creates an instance of the
CreateSubscriptionRequest.Builderavoiding the need to create one manually viaCreateSubscriptionRequest.builder()- Parameters:
createSubscriptionRequest- AConsumerthat will call methods onCreateSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateSubscription
default CompletableFuture<DeactivateSubscriptionResponse> deactivateSubscription(DeactivateSubscriptionRequest deactivateSubscriptionRequest) Deactivates a Subscription to stop billing for a user.
- Parameters:
deactivateSubscriptionRequest-- Returns:
- A Java Future containing the result of the DeactivateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateSubscription
default CompletableFuture<DeactivateSubscriptionResponse> deactivateSubscription(Consumer<DeactivateSubscriptionRequest.Builder> deactivateSubscriptionRequest) Deactivates a Subscription to stop billing for a user.
This is a convenience which creates an instance of the
DeactivateSubscriptionRequest.Builderavoiding the need to create one manually viaDeactivateSubscriptionRequest.builder()- Parameters:
deactivateSubscriptionRequest- AConsumerthat will call methods onDeactivateSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeactivateSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes a Domain and all associated resources.
- Parameters:
deleteDomainRequest-- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException This error is thrown when the requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes a Domain and all associated resources.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builderavoiding the need to create one manually viaDeleteDomainRequest.builder()- Parameters:
deleteDomainRequest- AConsumerthat will call methods onDeleteDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException This error is thrown when the requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomain
Retrieves information about a Domain.
- Parameters:
getDomainRequest-- Returns:
- A Java Future containing the result of the GetDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException This error is thrown when the requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomain
default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) Retrieves information about a Domain.
This is a convenience which creates an instance of the
GetDomainRequest.Builderavoiding the need to create one manually viaGetDomainRequest.builder()- Parameters:
getDomainRequest- AConsumerthat will call methods onGetDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException This error is thrown when the requested resource is not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMedicalScribeListeningSession
default CompletableFuture<GetMedicalScribeListeningSessionResponse> getMedicalScribeListeningSession(GetMedicalScribeListeningSessionRequest getMedicalScribeListeningSessionRequest) Retrieves details about an existing Medical Scribe listening session
- Parameters:
getMedicalScribeListeningSessionRequest-- Returns:
- A Java Future containing the result of the GetMedicalScribeListeningSession operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMedicalScribeListeningSession
default CompletableFuture<GetMedicalScribeListeningSessionResponse> getMedicalScribeListeningSession(Consumer<GetMedicalScribeListeningSessionRequest.Builder> getMedicalScribeListeningSessionRequest) Retrieves details about an existing Medical Scribe listening session
This is a convenience which creates an instance of the
GetMedicalScribeListeningSessionRequest.Builderavoiding the need to create one manually viaGetMedicalScribeListeningSessionRequest.builder()- Parameters:
getMedicalScribeListeningSessionRequest- AConsumerthat will call methods onGetMedicalScribeListeningSessionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetMedicalScribeListeningSession operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPatientInsightsJob
default CompletableFuture<GetPatientInsightsJobResponse> getPatientInsightsJob(GetPatientInsightsJobRequest getPatientInsightsJobRequest) Get details of a started patient insights job.
- Parameters:
getPatientInsightsJobRequest-- Returns:
- A Java Future containing the result of the GetPatientInsightsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPatientInsightsJob
default CompletableFuture<GetPatientInsightsJobResponse> getPatientInsightsJob(Consumer<GetPatientInsightsJobRequest.Builder> getPatientInsightsJobRequest) Get details of a started patient insights job.
This is a convenience which creates an instance of the
GetPatientInsightsJobRequest.Builderavoiding the need to create one manually viaGetPatientInsightsJobRequest.builder()- Parameters:
getPatientInsightsJobRequest- AConsumerthat will call methods onGetPatientInsightsJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetPatientInsightsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubscription
default CompletableFuture<GetSubscriptionResponse> getSubscription(GetSubscriptionRequest getSubscriptionRequest) Retrieves information about a Subscription.
- Parameters:
getSubscriptionRequest-- Returns:
- A Java Future containing the result of the GetSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubscription
default CompletableFuture<GetSubscriptionResponse> getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest) Retrieves information about a Subscription.
This is a convenience which creates an instance of the
GetSubscriptionRequest.Builderavoiding the need to create one manually viaGetSubscriptionRequest.builder()- Parameters:
getSubscriptionRequest- AConsumerthat will call methods onGetSubscriptionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
Lists Domains for a given account.
- Parameters:
listDomainsRequest-- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Lists Domains for a given account.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
This is a variant of
listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.connecthealth.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connecthealth.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation.- Parameters:
listDomainsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant of
listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.connecthealth.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connecthealth.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest)operation.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscriptions
default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) Lists all Subscriptions within a Domain.
- Parameters:
listSubscriptionsRequest-- Returns:
- A Java Future containing the result of the ListSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscriptions
default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) Lists all Subscriptions within a Domain.
This is a convenience which creates an instance of the
ListSubscriptionsRequest.Builderavoiding the need to create one manually viaListSubscriptionsRequest.builder()- Parameters:
listSubscriptionsRequest- AConsumerthat will call methods onListSubscriptionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscriptionsPaginator
default ListSubscriptionsPublisher listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest) This is a variant of
listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation.- Parameters:
listSubscriptionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSubscriptionsPaginator
default ListSubscriptionsPublisher listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest) This is a variant of
listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest)operation.
This is a convenience which creates an instance of the
ListSubscriptionsRequest.Builderavoiding the need to create one manually viaListSubscriptionsRequest.builder()- Parameters:
listSubscriptionsRequest- AConsumerthat will call methods onListSubscriptionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags associated with the specified resource
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags associated with the specified resource
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMedicalScribeListeningSession
default CompletableFuture<Void> startMedicalScribeListeningSession(StartMedicalScribeListeningSessionRequest startMedicalScribeListeningSessionRequest, org.reactivestreams.Publisher<MedicalScribeInputStream> requestStream, StartMedicalScribeListeningSessionResponseHandler asyncResponseHandler) Starts a new Medical Scribe listening session for real-time audio transcription
- Parameters:
startMedicalScribeListeningSessionRequest-- Returns:
- A Java Future containing the result of the StartMedicalScribeListeningSession operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMedicalScribeListeningSession
default CompletableFuture<Void> startMedicalScribeListeningSession(Consumer<StartMedicalScribeListeningSessionRequest.Builder> startMedicalScribeListeningSessionRequest, org.reactivestreams.Publisher<MedicalScribeInputStream> requestStream, StartMedicalScribeListeningSessionResponseHandler asyncResponseHandler) Starts a new Medical Scribe listening session for real-time audio transcription
This is a convenience which creates an instance of the
StartMedicalScribeListeningSessionRequest.Builderavoiding the need to create one manually viaStartMedicalScribeListeningSessionRequest.builder()- Parameters:
startMedicalScribeListeningSessionRequest- AConsumerthat will call methods onStartMedicalScribeListeningSessionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartMedicalScribeListeningSession operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ServiceQuotaExceededException The request exceeds a service quota.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPatientInsightsJob
default CompletableFuture<StartPatientInsightsJobResponse> startPatientInsightsJob(StartPatientInsightsJobRequest startPatientInsightsJobRequest) Starts a new patient insights job.
- Parameters:
startPatientInsightsJobRequest-- Returns:
- A Java Future containing the result of the StartPatientInsightsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ConflictException This error is thrown when a resource update is no longer valid due to assumptions about initial state changing.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startPatientInsightsJob
default CompletableFuture<StartPatientInsightsJobResponse> startPatientInsightsJob(Consumer<StartPatientInsightsJobRequest.Builder> startPatientInsightsJobRequest) Starts a new patient insights job.
This is a convenience which creates an instance of the
StartPatientInsightsJobRequest.Builderavoiding the need to create one manually viaStartPatientInsightsJobRequest.builder()- Parameters:
startPatientInsightsJobRequest- AConsumerthat will call methods onStartPatientInsightsJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartPatientInsightsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException This error is thrown when a transient error causes our API to fail.
- ResourceNotFoundException This error is thrown when the requested resource is not found.
- AccessDeniedException This error is thrown when the client does not supply proper credentials to the API.
- ValidationException This error is thrown when the client supplies invalid input to the API.
- ThrottlingException This error is thrown when the client exceeds the allowed request rate.
- ConflictException This error is thrown when a resource update is no longer valid due to assumptions about initial state changing.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Associates the specified tags with the specified resource
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags with the specified resource
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource
- Parameters:
untagResourceRequest-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConnectHealthException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aConnectHealthAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aConnectHealthAsyncClient.
-