Package software.amazon.awssdk.services.connectcontactlens

Interface ConnectContactLensAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectContactLensAsyncClient extends AwsClient
Service client for accessing Amazon Connect Contact Lens asynchronously. This can be created using the static 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.

Contact Lens for Amazon Connect enables you to analyze conversations between customer and agents, by using speech transcription, natural language processing, and intelligent search capabilities. It performs sentiment analysis, detects issues, and enables you to automatically categorize contacts.

Contact Lens for Amazon Connect provides both real-time and post-call analytics of customer-agent conversations. For more information, see Analyze conversations using Contact Lens in the Amazon Connect Administrator Guide.

  • Field Details

  • Method Details

    • listRealtimeContactAnalysisSegments

      default CompletableFuture<ListRealtimeContactAnalysisSegmentsResponse> listRealtimeContactAnalysisSegments(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)

      Provides a list of analysis segments for a real-time analysis session.

      Parameters:
      listRealtimeContactAnalysisSegmentsRequest -
      Returns:
      A Java Future containing the result of the ListRealtimeContactAnalysisSegments 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed due to an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • 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.
      • ConnectContactLensException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegments

      default CompletableFuture<ListRealtimeContactAnalysisSegmentsResponse> listRealtimeContactAnalysisSegments(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)

      Provides a list of analysis segments for a real-time analysis session.


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

      Parameters:
      listRealtimeContactAnalysisSegmentsRequest - A Consumer that will call methods on ListRealtimeContactAnalysisSegmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRealtimeContactAnalysisSegments 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed due to an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • 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.
      • ConnectContactLensException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsPaginator

      default ListRealtimeContactAnalysisSegmentsPublisher listRealtimeContactAnalysisSegmentsPaginator(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)

      This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) 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 new Subscription i.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 
       
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsPublisher publisher = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsPublisher publisher = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) operation.

      Parameters:
      listRealtimeContactAnalysisSegmentsRequest -
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed due to an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • 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.
      • ConnectContactLensException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsPaginator

      default ListRealtimeContactAnalysisSegmentsPublisher listRealtimeContactAnalysisSegmentsPaginator(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)

      This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) 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 new Subscription i.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 
       
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsPublisher publisher = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsPublisher publisher = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) operation.


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

      Parameters:
      listRealtimeContactAnalysisSegmentsRequest - A Consumer that will call methods on ListRealtimeContactAnalysisSegmentsRequest.Builder to 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed due to an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • 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.
      • ConnectContactLensException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ConnectContactLensServiceClientConfiguration 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

    • create

      static ConnectContactLensAsyncClient create()
      Create a ConnectContactLensAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ConnectContactLensAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ConnectContactLensAsyncClient.