Interface ConnectHealthClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface ConnectHealthClient
extends AwsClient

Service client for accessing Connect Health. This can be created using the static builder() method.

Health Agent for healthcare providers and patient engagement

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default ActivateSubscriptionResponse	activateSubscription(Consumer<ActivateSubscriptionRequest.Builder> activateSubscriptionRequest)	Activates a Subscription to enable billing for a user.
default ActivateSubscriptionResponse	activateSubscription(ActivateSubscriptionRequest activateSubscriptionRequest)	Activates a Subscription to enable billing for a user.
static ConnectHealthClientBuilder	builder()	Create a builder that can be used to configure and create a ConnectHealthClient.
static ConnectHealthClient	create()	Create a ConnectHealthClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDomainResponse	createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)	Creates a new Domain for managing HealthAgent resources.
default CreateDomainResponse	createDomain(CreateDomainRequest createDomainRequest)	Creates a new Domain for managing HealthAgent resources.
default CreateSubscriptionResponse	createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)	Creates a new Subscription within a Domain for billing and user management.
default CreateSubscriptionResponse	createSubscription(CreateSubscriptionRequest createSubscriptionRequest)	Creates a new Subscription within a Domain for billing and user management.
default DeactivateSubscriptionResponse	deactivateSubscription(Consumer<DeactivateSubscriptionRequest.Builder> deactivateSubscriptionRequest)	Deactivates a Subscription to stop billing for a user.
default DeactivateSubscriptionResponse	deactivateSubscription(DeactivateSubscriptionRequest deactivateSubscriptionRequest)	Deactivates a Subscription to stop billing for a user.
default DeleteDomainResponse	deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)	Deletes a Domain and all associated resources.
default DeleteDomainResponse	deleteDomain(DeleteDomainRequest deleteDomainRequest)	Deletes a Domain and all associated resources.
default GetDomainResponse	getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)	Retrieves information about a Domain.
default GetDomainResponse	getDomain(GetDomainRequest getDomainRequest)	Retrieves information about a Domain.
default GetMedicalScribeListeningSessionResponse	getMedicalScribeListeningSession(Consumer<GetMedicalScribeListeningSessionRequest.Builder> getMedicalScribeListeningSessionRequest)	Retrieves details about an existing Medical Scribe listening session
default GetMedicalScribeListeningSessionResponse	getMedicalScribeListeningSession(GetMedicalScribeListeningSessionRequest getMedicalScribeListeningSessionRequest)	Retrieves details about an existing Medical Scribe listening session
default GetPatientInsightsJobResponse	getPatientInsightsJob(Consumer<GetPatientInsightsJobRequest.Builder> getPatientInsightsJobRequest)	Get details of a started patient insights job.
default GetPatientInsightsJobResponse	getPatientInsightsJob(GetPatientInsightsJobRequest getPatientInsightsJobRequest)	Get details of a started patient insights job.
default GetSubscriptionResponse	getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest)	Retrieves information about a Subscription.
default GetSubscriptionResponse	getSubscription(GetSubscriptionRequest getSubscriptionRequest)	Retrieves information about a Subscription.
default ListDomainsResponse	listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	Lists Domains for a given account.
default ListDomainsResponse	listDomains(ListDomainsRequest listDomainsRequest)	Lists Domains for a given account.
default ListDomainsIterable	listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest) operation.
default ListDomainsIterable	listDomainsPaginator(ListDomainsRequest listDomainsRequest)	This is a variant of listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest) operation.
default ListSubscriptionsResponse	listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)	Lists all Subscriptions within a Domain.
default ListSubscriptionsResponse	listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)	Lists all Subscriptions within a Domain.
default ListSubscriptionsIterable	listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)	This is a variant of listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest) operation.
default ListSubscriptionsIterable	listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)	This is a variant of listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags associated with the specified resource
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags associated with the specified resource
default ConnectHealthServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartPatientInsightsJobResponse	startPatientInsightsJob(Consumer<StartPatientInsightsJobRequest.Builder> startPatientInsightsJobRequest)	Starts a new patient insights job.
default StartPatientInsightsJobResponse	startPatientInsightsJob(StartPatientInsightsJobRequest startPatientInsightsJobRequest)	Starts a new patient insights job.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associates the specified tags with the specified resource
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associates the specified tags with the specified resource
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags from the specified resource
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags from the specified resource

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

activateSubscription

default ActivateSubscriptionResponse activateSubscription(ActivateSubscriptionRequest activateSubscriptionRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Activates a Subscription to enable billing for a user.

Parameters:

activateSubscriptionRequest -

Returns:

Result of the ActivateSubscription operation returned by the service.

See Also:

• AWS API Documentation

activateSubscription

default ActivateSubscriptionResponse activateSubscription(Consumer<ActivateSubscriptionRequest.Builder> activateSubscriptionRequest)
                                                   throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Activates a Subscription to enable billing for a user.

This is a convenience which creates an instance of the ActivateSubscriptionRequest.Builder avoiding the need to create one manually via ActivateSubscriptionRequest.builder()

Parameters:

activateSubscriptionRequest - A Consumer that will call methods on ActivateSubscriptionRequest.Builder to create a request.

Returns:

Result of the ActivateSubscription operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest)
                                   throws ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Creates a new Domain for managing HealthAgent resources.

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createDomain

default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
                                   throws ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Creates a new Domain for managing HealthAgent resources.

This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to create one manually via CreateDomainRequest.builder()

Parameters:

createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.

Returns:

Result of the CreateDomain operation returned by the service.

See Also:

• AWS API Documentation

createSubscription

default CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

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

Parameters:

createSubscriptionRequest -

Returns:

Result of the CreateSubscription operation returned by the service.

See Also:

• AWS API Documentation

createSubscription

default CreateSubscriptionResponse createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)
                                               throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

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

This is a convenience which creates an instance of the CreateSubscriptionRequest.Builder avoiding the need to create one manually via CreateSubscriptionRequest.builder()

Parameters:

createSubscriptionRequest - A Consumer that will call methods on CreateSubscriptionRequest.Builder to create a request.

Returns:

Result of the CreateSubscription operation returned by the service.

See Also:

• AWS API Documentation

deactivateSubscription

default DeactivateSubscriptionResponse deactivateSubscription(DeactivateSubscriptionRequest deactivateSubscriptionRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Deactivates a Subscription to stop billing for a user.

Parameters:

deactivateSubscriptionRequest -

Returns:

Result of the DeactivateSubscription operation returned by the service.

See Also:

• AWS API Documentation

deactivateSubscription

default DeactivateSubscriptionResponse deactivateSubscription(Consumer<DeactivateSubscriptionRequest.Builder> deactivateSubscriptionRequest)
                                                       throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Deactivates a Subscription to stop billing for a user.

This is a convenience which creates an instance of the DeactivateSubscriptionRequest.Builder avoiding the need to create one manually via DeactivateSubscriptionRequest.builder()

Parameters:

deactivateSubscriptionRequest - A Consumer that will call methods on DeactivateSubscriptionRequest.Builder to create a request.

Returns:

Result of the DeactivateSubscription operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                   throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Deletes a Domain and all associated resources.

Parameters:

deleteDomainRequest -

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

deleteDomain

default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
                                   throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Deletes a Domain and all associated resources.

This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to create one manually via DeleteDomainRequest.builder()

Parameters:

deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.

Returns:

Result of the DeleteDomain operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(GetDomainRequest getDomainRequest)
                             throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves information about a Domain.

Parameters:

getDomainRequest -

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getDomain

default GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
                             throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves information about a Domain.

This is a convenience which creates an instance of the GetDomainRequest.Builder avoiding the need to create one manually via GetDomainRequest.builder()

Parameters:

getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.

Returns:

Result of the GetDomain operation returned by the service.

See Also:

• AWS API Documentation

getMedicalScribeListeningSession

default GetMedicalScribeListeningSessionResponse getMedicalScribeListeningSession(GetMedicalScribeListeningSessionRequest getMedicalScribeListeningSessionRequest)
                                                                           throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves details about an existing Medical Scribe listening session

Parameters:

getMedicalScribeListeningSessionRequest -

Returns:

Result of the GetMedicalScribeListeningSession operation returned by the service.

See Also:

• AWS API Documentation

getMedicalScribeListeningSession

default GetMedicalScribeListeningSessionResponse getMedicalScribeListeningSession(Consumer<GetMedicalScribeListeningSessionRequest.Builder> getMedicalScribeListeningSessionRequest)
                                                                           throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves details about an existing Medical Scribe listening session

This is a convenience which creates an instance of the GetMedicalScribeListeningSessionRequest.Builder avoiding the need to create one manually via GetMedicalScribeListeningSessionRequest.builder()

Parameters:

getMedicalScribeListeningSessionRequest - A Consumer that will call methods on GetMedicalScribeListeningSessionRequest.Builder to create a request.

Returns:

Result of the GetMedicalScribeListeningSession operation returned by the service.

See Also:

• AWS API Documentation

getPatientInsightsJob

default GetPatientInsightsJobResponse getPatientInsightsJob(GetPatientInsightsJobRequest getPatientInsightsJobRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Get details of a started patient insights job.

Parameters:

getPatientInsightsJobRequest -

Returns:

Result of the GetPatientInsightsJob operation returned by the service.

See Also:

• AWS API Documentation

getPatientInsightsJob

default GetPatientInsightsJobResponse getPatientInsightsJob(Consumer<GetPatientInsightsJobRequest.Builder> getPatientInsightsJobRequest)
                                                     throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Get details of a started patient insights job.

This is a convenience which creates an instance of the GetPatientInsightsJobRequest.Builder avoiding the need to create one manually via GetPatientInsightsJobRequest.builder()

Parameters:

getPatientInsightsJobRequest - A Consumer that will call methods on GetPatientInsightsJobRequest.Builder to create a request.

Returns:

Result of the GetPatientInsightsJob operation returned by the service.

See Also:

• AWS API Documentation

getSubscription

default GetSubscriptionResponse getSubscription(GetSubscriptionRequest getSubscriptionRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves information about a Subscription.

Parameters:

getSubscriptionRequest -

Returns:

Result of the GetSubscription operation returned by the service.

See Also:

• AWS API Documentation

getSubscription

default GetSubscriptionResponse getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest)
                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Retrieves information about a Subscription.

This is a convenience which creates an instance of the GetSubscriptionRequest.Builder avoiding the need to create one manually via GetSubscriptionRequest.builder()

Parameters:

getSubscriptionRequest - A Consumer that will call methods on GetSubscriptionRequest.Builder to create a request.

Returns:

Result of the GetSubscription operation returned by the service.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest)
                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Lists Domains for a given account.

Parameters:

listDomainsRequest -

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomains

default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Lists Domains for a given account.

This is a convenience which creates an instance of the ListDomainsRequest.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

Result of the ListDomains operation returned by the service.

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest)
                                          throws AwsServiceException,
SdkClientException,
ConnectHealthException

This is a variant of listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
     for (software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDomainsPaginator

default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
                                          throws AwsServiceException,
SdkClientException,
ConnectHealthException

This is a variant of listDomains(software.amazon.awssdk.services.connecthealth.model.ListDomainsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
     for (software.amazon.awssdk.services.connecthealth.model.ListDomainsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connecthealth.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListDomainsRequest.builder()

Parameters:

listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSubscriptions

default ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Lists all Subscriptions within a Domain.

Parameters:

listSubscriptionsRequest -

Returns:

Result of the ListSubscriptions operation returned by the service.

See Also:

• AWS API Documentation

listSubscriptions

default ListSubscriptionsResponse listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
                                             throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Lists all Subscriptions within a Domain.

This is a convenience which creates an instance of the ListSubscriptionsRequest.Builder avoiding the need to create one manually via ListSubscriptionsRequest.builder()

Parameters:

listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request.

Returns:

Result of the ListSubscriptions operation returned by the service.

See Also:

• AWS API Documentation

listSubscriptionsPaginator

default ListSubscriptionsIterable listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)
                                                      throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

This is a variant of listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client
             .listSubscriptionsPaginator(request);
     for (software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSubscriptionsPaginator

default ListSubscriptionsIterable listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)
                                                      throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ConnectHealthException

This is a variant of listSubscriptions(software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client
             .listSubscriptionsPaginator(request);
     for (software.amazon.awssdk.services.connecthealth.model.ListSubscriptionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connecthealth.paginators.ListSubscriptionsIterable responses = client.listSubscriptionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.Builder avoiding the need to create one manually via ListSubscriptionsRequest.builder()

Parameters:

listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Lists the tags associated with the specified resource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Lists the tags associated with the specified resource

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startPatientInsightsJob

default StartPatientInsightsJobResponse startPatientInsightsJob(StartPatientInsightsJobRequest startPatientInsightsJobRequest)
                                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Starts a new patient insights job.

Parameters:

startPatientInsightsJobRequest -

Returns:

Result of the StartPatientInsightsJob operation returned by the service.

See Also:

• AWS API Documentation

startPatientInsightsJob

default StartPatientInsightsJobResponse startPatientInsightsJob(Consumer<StartPatientInsightsJobRequest.Builder> startPatientInsightsJobRequest)
                                                         throws InternalServerException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
ConnectHealthException

Starts a new patient insights job.

This is a convenience which creates an instance of the StartPatientInsightsJobRequest.Builder avoiding the need to create one manually via StartPatientInsightsJobRequest.builder()

Parameters:

startPatientInsightsJobRequest - A Consumer that will call methods on StartPatientInsightsJobRequest.Builder to create a request.

Returns:

Result of the StartPatientInsightsJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Associates the specified tags with the specified resource

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AwsServiceException,
SdkClientException,
ConnectHealthException

Associates the specified tags with the specified resource

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AwsServiceException,
SdkClientException,
ConnectHealthException

Removes the specified tags from the specified resource

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AwsServiceException,
SdkClientException,
ConnectHealthException

Removes the specified tags from the specified resource

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static ConnectHealthClient create()

Create a ConnectHealthClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ConnectHealthClientBuilder builder()

Create a builder that can be used to configure and create a ConnectHealthClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ConnectHealthServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration