Package software.amazon.awssdk.services.connectcontactlens

Interface ConnectContactLensClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

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 Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ConnectContactLensClientBuilder	builder()	Create a builder that can be used to configure and create a ConnectContactLensClient.
static ConnectContactLensClient	create()	Create a ConnectContactLensClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default ListRealtimeContactAnalysisSegmentsResponse	listRealtimeContactAnalysisSegments(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)	Provides a list of analysis segments for a real-time analysis session.
default ListRealtimeContactAnalysisSegmentsResponse	listRealtimeContactAnalysisSegments(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)	Provides a list of analysis segments for a real-time analysis session.
default ListRealtimeContactAnalysisSegmentsIterable	listRealtimeContactAnalysisSegmentsPaginator(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)	This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) operation.
default ListRealtimeContactAnalysisSegmentsIterable	listRealtimeContactAnalysisSegmentsPaginator(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)	This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) operation.
default ConnectContactLensServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

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

close

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

serviceName

Field Detail

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 Detail

listRealtimeContactAnalysisSegments

default ListRealtimeContactAnalysisSegmentsResponse listRealtimeContactAnalysisSegments(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)
                                                                                 throws InvalidRequestException,
                                                                                        AccessDeniedException,
                                                                                        ResourceNotFoundException,
                                                                                        InternalServiceException,
                                                                                        ThrottlingException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConnectContactLensException

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

Parameters:

listRealtimeContactAnalysisSegmentsRequest -

Returns:

Result of the ListRealtimeContactAnalysisSegments operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listRealtimeContactAnalysisSegments

default ListRealtimeContactAnalysisSegmentsResponse listRealtimeContactAnalysisSegments(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)
                                                                                 throws InvalidRequestException,
                                                                                        AccessDeniedException,
                                                                                        ResourceNotFoundException,
                                                                                        InternalServiceException,
                                                                                        ThrottlingException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConnectContactLensException

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:

Result of the ListRealtimeContactAnalysisSegments operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listRealtimeContactAnalysisSegmentsPaginator

default ListRealtimeContactAnalysisSegmentsIterable listRealtimeContactAnalysisSegmentsPaginator(ListRealtimeContactAnalysisSegmentsRequest listRealtimeContactAnalysisSegmentsRequest)
                                                                                          throws InvalidRequestException,
                                                                                                 AccessDeniedException,
                                                                                                 ResourceNotFoundException,
                                                                                                 InternalServiceException,
                                                                                                 ThrottlingException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConnectContactLensException

This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) 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.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client
             .listRealtimeContactAnalysisSegmentsPaginator(request);
     for (software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client.listRealtimeContactAnalysisSegmentsPaginator(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 listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) operation.

Parameters:

listRealtimeContactAnalysisSegmentsRequest -

Returns:

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

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listRealtimeContactAnalysisSegmentsPaginator

default ListRealtimeContactAnalysisSegmentsIterable listRealtimeContactAnalysisSegmentsPaginator(Consumer<ListRealtimeContactAnalysisSegmentsRequest.Builder> listRealtimeContactAnalysisSegmentsRequest)
                                                                                          throws InvalidRequestException,
                                                                                                 AccessDeniedException,
                                                                                                 ResourceNotFoundException,
                                                                                                 InternalServiceException,
                                                                                                 ThrottlingException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConnectContactLensException

This is a variant of listRealtimeContactAnalysisSegments(software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsRequest) 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.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client.listRealtimeContactAnalysisSegmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client
             .listRealtimeContactAnalysisSegmentsPaginator(request);
     for (software.amazon.awssdk.services.connectcontactlens.model.ListRealtimeContactAnalysisSegmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.connectcontactlens.paginators.ListRealtimeContactAnalysisSegmentsIterable responses = client.listRealtimeContactAnalysisSegmentsPaginator(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 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 iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static ConnectContactLensClient create()

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

builder

static ConnectContactLensClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ConnectContactLensServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient