Interface ConnectAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ConnectAsyncClient extends AwsClient
Service client for accessing Amazon Connect 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.

Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.

There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

  • Field Details

  • Method Details

    • activateEvaluationForm

      default CompletableFuture<ActivateEvaluationFormResponse> activateEvaluationForm(ActivateEvaluationFormRequest activateEvaluationFormRequest)

      Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.

      Parameters:
      activateEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the ActivateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateEvaluationForm

      default CompletableFuture<ActivateEvaluationFormResponse> activateEvaluationForm(Consumer<ActivateEvaluationFormRequest.Builder> activateEvaluationFormRequest)

      Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.


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

      Parameters:
      activateEvaluationFormRequest - A Consumer that will call methods on ActivateEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ActivateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateAnalyticsDataSet

      default CompletableFuture<AssociateAnalyticsDataSetResponse> associateAnalyticsDataSet(AssociateAnalyticsDataSetRequest associateAnalyticsDataSetRequest)

      Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

      Parameters:
      associateAnalyticsDataSetRequest -
      Returns:
      A Java Future containing the result of the AssociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateAnalyticsDataSet

      default CompletableFuture<AssociateAnalyticsDataSetResponse> associateAnalyticsDataSet(Consumer<AssociateAnalyticsDataSetRequest.Builder> associateAnalyticsDataSetRequest)

      Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.


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

      Parameters:
      associateAnalyticsDataSetRequest - A Consumer that will call methods on AssociateAnalyticsDataSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateApprovedOrigin

      default CompletableFuture<AssociateApprovedOriginResponse> associateApprovedOrigin(AssociateApprovedOriginRequest associateApprovedOriginRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates an approved origin to an Amazon Connect instance.

      Parameters:
      associateApprovedOriginRequest -
      Returns:
      A Java Future containing the result of the AssociateApprovedOrigin 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateApprovedOrigin

      default CompletableFuture<AssociateApprovedOriginResponse> associateApprovedOrigin(Consumer<AssociateApprovedOriginRequest.Builder> associateApprovedOriginRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates an approved origin to an Amazon Connect instance.


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

      Parameters:
      associateApprovedOriginRequest - A Consumer that will call methods on AssociateApprovedOriginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateApprovedOrigin 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateBot

      default CompletableFuture<AssociateBotResponse> associateBot(AssociateBotRequest associateBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

      Parameters:
      associateBotRequest -
      Returns:
      A Java Future containing the result of the AssociateBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateBot

      default CompletableFuture<AssociateBotResponse> associateBot(Consumer<AssociateBotRequest.Builder> associateBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.


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

      Parameters:
      associateBotRequest - A Consumer that will call methods on AssociateBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateDefaultVocabulary

      default CompletableFuture<AssociateDefaultVocabularyResponse> associateDefaultVocabulary(AssociateDefaultVocabularyRequest associateDefaultVocabularyRequest)

      Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

      Parameters:
      associateDefaultVocabularyRequest -
      Returns:
      A Java Future containing the result of the AssociateDefaultVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateDefaultVocabulary

      default CompletableFuture<AssociateDefaultVocabularyResponse> associateDefaultVocabulary(Consumer<AssociateDefaultVocabularyRequest.Builder> associateDefaultVocabularyRequest)

      Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.


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

      Parameters:
      associateDefaultVocabularyRequest - A Consumer that will call methods on AssociateDefaultVocabularyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateDefaultVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateFlow

      default CompletableFuture<AssociateFlowResponse> associateFlow(AssociateFlowRequest associateFlowRequest)

      Associates a connect resource to a flow.

      Parameters:
      associateFlowRequest -
      Returns:
      A Java Future containing the result of the AssociateFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateFlow

      default CompletableFuture<AssociateFlowResponse> associateFlow(Consumer<AssociateFlowRequest.Builder> associateFlowRequest)

      Associates a connect resource to a flow.


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

      Parameters:
      associateFlowRequest - A Consumer that will call methods on AssociateFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateInstanceStorageConfig

      default CompletableFuture<AssociateInstanceStorageConfigResponse> associateInstanceStorageConfig(AssociateInstanceStorageConfigRequest associateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

      This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

      Parameters:
      associateInstanceStorageConfigRequest -
      Returns:
      A Java Future containing the result of the AssociateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateInstanceStorageConfig

      default CompletableFuture<AssociateInstanceStorageConfigResponse> associateInstanceStorageConfig(Consumer<AssociateInstanceStorageConfigRequest.Builder> associateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

      This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.


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

      Parameters:
      associateInstanceStorageConfigRequest - A Consumer that will call methods on AssociateInstanceStorageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateLambdaFunction

      default CompletableFuture<AssociateLambdaFunctionResponse> associateLambdaFunction(AssociateLambdaFunctionRequest associateLambdaFunctionRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Lambda function.

      Parameters:
      associateLambdaFunctionRequest -
      Returns:
      A Java Future containing the result of the AssociateLambdaFunction 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateLambdaFunction

      default CompletableFuture<AssociateLambdaFunctionResponse> associateLambdaFunction(Consumer<AssociateLambdaFunctionRequest.Builder> associateLambdaFunctionRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Lambda function.


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

      Parameters:
      associateLambdaFunctionRequest - A Consumer that will call methods on AssociateLambdaFunctionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateLambdaFunction 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateLexBot

      default CompletableFuture<AssociateLexBotResponse> associateLexBot(AssociateLexBotRequest associateLexBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

      Parameters:
      associateLexBotRequest -
      Returns:
      A Java Future containing the result of the AssociateLexBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateLexBot

      default CompletableFuture<AssociateLexBotResponse> associateLexBot(Consumer<AssociateLexBotRequest.Builder> associateLexBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.


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

      Parameters:
      associateLexBotRequest - A Consumer that will call methods on AssociateLexBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateLexBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePhoneNumberContactFlow

      default CompletableFuture<AssociatePhoneNumberContactFlowResponse> associatePhoneNumberContactFlow(AssociatePhoneNumberContactFlowRequest associatePhoneNumberContactFlowRequest)

      Associates a flow with a phone number claimed to your Amazon Connect instance.

      If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      Parameters:
      associatePhoneNumberContactFlowRequest -
      Returns:
      A Java Future containing the result of the AssociatePhoneNumberContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associatePhoneNumberContactFlow

      default CompletableFuture<AssociatePhoneNumberContactFlowResponse> associatePhoneNumberContactFlow(Consumer<AssociatePhoneNumberContactFlowRequest.Builder> associatePhoneNumberContactFlowRequest)

      Associates a flow with a phone number claimed to your Amazon Connect instance.

      If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.


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

      Parameters:
      associatePhoneNumberContactFlowRequest - A Consumer that will call methods on AssociatePhoneNumberContactFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociatePhoneNumberContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateQueueQuickConnects

      default CompletableFuture<AssociateQueueQuickConnectsResponse> associateQueueQuickConnects(AssociateQueueQuickConnectsRequest associateQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a set of quick connects with a queue.

      Parameters:
      associateQueueQuickConnectsRequest -
      Returns:
      A Java Future containing the result of the AssociateQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateQueueQuickConnects

      default CompletableFuture<AssociateQueueQuickConnectsResponse> associateQueueQuickConnects(Consumer<AssociateQueueQuickConnectsRequest.Builder> associateQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a set of quick connects with a queue.


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

      Parameters:
      associateQueueQuickConnectsRequest - A Consumer that will call methods on AssociateQueueQuickConnectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateRoutingProfileQueues

      default CompletableFuture<AssociateRoutingProfileQueuesResponse> associateRoutingProfileQueues(AssociateRoutingProfileQueuesRequest associateRoutingProfileQueuesRequest)

      Associates a set of queues with a routing profile.

      Parameters:
      associateRoutingProfileQueuesRequest -
      Returns:
      A Java Future containing the result of the AssociateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateRoutingProfileQueues

      default CompletableFuture<AssociateRoutingProfileQueuesResponse> associateRoutingProfileQueues(Consumer<AssociateRoutingProfileQueuesRequest.Builder> associateRoutingProfileQueuesRequest)

      Associates a set of queues with a routing profile.


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

      Parameters:
      associateRoutingProfileQueuesRequest - A Consumer that will call methods on AssociateRoutingProfileQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateSecurityKey

      default CompletableFuture<AssociateSecurityKeyResponse> associateSecurityKey(AssociateSecurityKeyRequest associateSecurityKeyRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a security key to the instance.

      Parameters:
      associateSecurityKeyRequest -
      Returns:
      A Java Future containing the result of the AssociateSecurityKey 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateSecurityKey

      default CompletableFuture<AssociateSecurityKeyResponse> associateSecurityKey(Consumer<AssociateSecurityKeyRequest.Builder> associateSecurityKeyRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Associates a security key to the instance.


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

      Parameters:
      associateSecurityKeyRequest - A Consumer that will call methods on AssociateSecurityKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateSecurityKey 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.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTrafficDistributionGroupUser

      default CompletableFuture<AssociateTrafficDistributionGroupUserResponse> associateTrafficDistributionGroupUser(AssociateTrafficDistributionGroupUserRequest associateTrafficDistributionGroupUserRequest)

      Associates an agent with a traffic distribution group.

      Parameters:
      associateTrafficDistributionGroupUserRequest -
      Returns:
      A Java Future containing the result of the AssociateTrafficDistributionGroupUser 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateTrafficDistributionGroupUser

      default CompletableFuture<AssociateTrafficDistributionGroupUserResponse> associateTrafficDistributionGroupUser(Consumer<AssociateTrafficDistributionGroupUserRequest.Builder> associateTrafficDistributionGroupUserRequest)

      Associates an agent with a traffic distribution group.


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

      Parameters:
      associateTrafficDistributionGroupUserRequest - A Consumer that will call methods on AssociateTrafficDistributionGroupUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateTrafficDistributionGroupUser 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateUserProficiencies

      default CompletableFuture<AssociateUserProficienciesResponse> associateUserProficiencies(AssociateUserProficienciesRequest associateUserProficienciesRequest)

      >Associates a set of proficiencies with a user.

      Parameters:
      associateUserProficienciesRequest -
      Returns:
      A Java Future containing the result of the AssociateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateUserProficiencies

      default CompletableFuture<AssociateUserProficienciesResponse> associateUserProficiencies(Consumer<AssociateUserProficienciesRequest.Builder> associateUserProficienciesRequest)

      >Associates a set of proficiencies with a user.


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

      Parameters:
      associateUserProficienciesRequest - A Consumer that will call methods on AssociateUserProficienciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchAssociateAnalyticsDataSet

      default CompletableFuture<BatchAssociateAnalyticsDataSetResponse> batchAssociateAnalyticsDataSet(BatchAssociateAnalyticsDataSetRequest batchAssociateAnalyticsDataSetRequest)

      Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

      Parameters:
      batchAssociateAnalyticsDataSetRequest -
      Returns:
      A Java Future containing the result of the BatchAssociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchAssociateAnalyticsDataSet

      default CompletableFuture<BatchAssociateAnalyticsDataSetResponse> batchAssociateAnalyticsDataSet(Consumer<BatchAssociateAnalyticsDataSetRequest.Builder> batchAssociateAnalyticsDataSetRequest)

      Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.


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

      Parameters:
      batchAssociateAnalyticsDataSetRequest - A Consumer that will call methods on BatchAssociateAnalyticsDataSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchAssociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDisassociateAnalyticsDataSet

      default CompletableFuture<BatchDisassociateAnalyticsDataSetResponse> batchDisassociateAnalyticsDataSet(BatchDisassociateAnalyticsDataSetRequest batchDisassociateAnalyticsDataSetRequest)

      Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

      Parameters:
      batchDisassociateAnalyticsDataSetRequest -
      Returns:
      A Java Future containing the result of the BatchDisassociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDisassociateAnalyticsDataSet

      default CompletableFuture<BatchDisassociateAnalyticsDataSetResponse> batchDisassociateAnalyticsDataSet(Consumer<BatchDisassociateAnalyticsDataSetRequest.Builder> batchDisassociateAnalyticsDataSetRequest)

      Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.


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

      Parameters:
      batchDisassociateAnalyticsDataSetRequest - A Consumer that will call methods on BatchDisassociateAnalyticsDataSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDisassociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAttachedFileMetadata

      default CompletableFuture<BatchGetAttachedFileMetadataResponse> batchGetAttachedFileMetadata(BatchGetAttachedFileMetadataRequest batchGetAttachedFileMetadataRequest)

      Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

      Parameters:
      batchGetAttachedFileMetadataRequest -
      Returns:
      A Java Future containing the result of the BatchGetAttachedFileMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetAttachedFileMetadata

      default CompletableFuture<BatchGetAttachedFileMetadataResponse> batchGetAttachedFileMetadata(Consumer<BatchGetAttachedFileMetadataRequest.Builder> batchGetAttachedFileMetadataRequest)

      Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.


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

      Parameters:
      batchGetAttachedFileMetadataRequest - A Consumer that will call methods on BatchGetAttachedFileMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetAttachedFileMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetFlowAssociation

      default CompletableFuture<BatchGetFlowAssociationResponse> batchGetFlowAssociation(BatchGetFlowAssociationRequest batchGetFlowAssociationRequest)

      Retrieve the flow associations for the given resources.

      Parameters:
      batchGetFlowAssociationRequest -
      Returns:
      A Java Future containing the result of the BatchGetFlowAssociation 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetFlowAssociation

      default CompletableFuture<BatchGetFlowAssociationResponse> batchGetFlowAssociation(Consumer<BatchGetFlowAssociationRequest.Builder> batchGetFlowAssociationRequest)

      Retrieve the flow associations for the given resources.


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

      Parameters:
      batchGetFlowAssociationRequest - A Consumer that will call methods on BatchGetFlowAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetFlowAssociation 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutContact

      default CompletableFuture<BatchPutContactResponse> batchPutContact(BatchPutContactRequest batchPutContactRequest)

      Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

      Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

      Parameters:
      batchPutContactRequest -
      Returns:
      A Java Future containing the result of the BatchPutContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • IdempotencyException An entity with the same name already exists.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchPutContact

      default CompletableFuture<BatchPutContactResponse> batchPutContact(Consumer<BatchPutContactRequest.Builder> batchPutContactRequest)

      Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

      Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.


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

      Parameters:
      batchPutContactRequest - A Consumer that will call methods on BatchPutContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchPutContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • IdempotencyException An entity with the same name already exists.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • claimPhoneNumber

      default CompletableFuture<ClaimPhoneNumberResponse> claimPhoneNumber(ClaimPhoneNumberRequest claimPhoneNumberRequest)

      Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

      For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

      You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

      If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

      Parameters:
      claimPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the ClaimPhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • claimPhoneNumber

      default CompletableFuture<ClaimPhoneNumberResponse> claimPhoneNumber(Consumer<ClaimPhoneNumberRequest.Builder> claimPhoneNumberRequest)

      Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

      For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.

      You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.

      If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.


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

      Parameters:
      claimPhoneNumberRequest - A Consumer that will call methods on ClaimPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ClaimPhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • completeAttachedFileUpload

      default CompletableFuture<CompleteAttachedFileUploadResponse> completeAttachedFileUpload(CompleteAttachedFileUploadRequest completeAttachedFileUploadRequest)

      Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

      Parameters:
      completeAttachedFileUploadRequest - Request to CompleteAttachedFileUpload API
      Returns:
      A Java Future containing the result of the CompleteAttachedFileUpload 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • completeAttachedFileUpload

      default CompletableFuture<CompleteAttachedFileUploadResponse> completeAttachedFileUpload(Consumer<CompleteAttachedFileUploadRequest.Builder> completeAttachedFileUploadRequest)

      Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.


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

      Parameters:
      completeAttachedFileUploadRequest - A Consumer that will call methods on CompleteAttachedFileUploadRequest.Builder to create a request. Request to CompleteAttachedFileUpload API
      Returns:
      A Java Future containing the result of the CompleteAttachedFileUpload 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentStatus

      default CompletableFuture<CreateAgentStatusResponse> createAgentStatus(CreateAgentStatusRequest createAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates an agent status for the specified Amazon Connect instance.

      Parameters:
      createAgentStatusRequest -
      Returns:
      A Java Future containing the result of the CreateAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentStatus

      default CompletableFuture<CreateAgentStatusResponse> createAgentStatus(Consumer<CreateAgentStatusRequest.Builder> createAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates an agent status for the specified Amazon Connect instance.


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

      Parameters:
      createAgentStatusRequest - A Consumer that will call methods on CreateAgentStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactFlow

      default CompletableFuture<CreateContactFlowResponse> createContactFlow(CreateContactFlowRequest createContactFlowRequest)

      Creates a flow for the specified Amazon Connect instance.

      You can also create and update flows using the Amazon Connect Flow language.

      Parameters:
      createContactFlowRequest -
      Returns:
      A Java Future containing the result of the CreateContactFlow 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.
      • InvalidContactFlowException The flow is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactFlow

      default CompletableFuture<CreateContactFlowResponse> createContactFlow(Consumer<CreateContactFlowRequest.Builder> createContactFlowRequest)

      Creates a flow for the specified Amazon Connect instance.

      You can also create and update flows using the Amazon Connect Flow language.


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

      Parameters:
      createContactFlowRequest - A Consumer that will call methods on CreateContactFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContactFlow 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.
      • InvalidContactFlowException The flow is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactFlowModule

      default CompletableFuture<CreateContactFlowModuleResponse> createContactFlowModule(CreateContactFlowModuleRequest createContactFlowModuleRequest)

      Creates a flow module for the specified Amazon Connect instance.

      Parameters:
      createContactFlowModuleRequest -
      Returns:
      A Java Future containing the result of the CreateContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidContactFlowModuleException The problems with the module. Please fix before trying again.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • IdempotencyException An entity with the same name already exists.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactFlowModule

      default CompletableFuture<CreateContactFlowModuleResponse> createContactFlowModule(Consumer<CreateContactFlowModuleRequest.Builder> createContactFlowModuleRequest)

      Creates a flow module for the specified Amazon Connect instance.


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

      Parameters:
      createContactFlowModuleRequest - A Consumer that will call methods on CreateContactFlowModuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidContactFlowModuleException The problems with the module. Please fix before trying again.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • IdempotencyException An entity with the same name already exists.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEvaluationForm

      default CompletableFuture<CreateEvaluationFormResponse> createEvaluationForm(CreateEvaluationFormRequest createEvaluationFormRequest)

      Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

      Parameters:
      createEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the CreateEvaluationForm 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createEvaluationForm

      default CompletableFuture<CreateEvaluationFormResponse> createEvaluationForm(Consumer<CreateEvaluationFormRequest.Builder> createEvaluationFormRequest)

      Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.


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

      Parameters:
      createEvaluationFormRequest - A Consumer that will call methods on CreateEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEvaluationForm 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHoursOfOperation

      default CompletableFuture<CreateHoursOfOperationResponse> createHoursOfOperation(CreateHoursOfOperationRequest createHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates hours of operation.

      Parameters:
      createHoursOfOperationRequest -
      Returns:
      A Java Future containing the result of the CreateHoursOfOperation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHoursOfOperation

      default CompletableFuture<CreateHoursOfOperationResponse> createHoursOfOperation(Consumer<CreateHoursOfOperationRequest.Builder> createHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates hours of operation.


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

      Parameters:
      createHoursOfOperationRequest - A Consumer that will call methods on CreateHoursOfOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateHoursOfOperation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstance

      default CompletableFuture<CreateInstanceResponse> createInstance(CreateInstanceRequest createInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

      For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.

      Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

      Parameters:
      createInstanceRequest -
      Returns:
      A Java Future containing the result of the CreateInstance 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.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstance

      default CompletableFuture<CreateInstanceResponse> createInstance(Consumer<CreateInstanceRequest.Builder> createInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.

      For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide.

      Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.


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

      Parameters:
      createInstanceRequest - A Consumer that will call methods on CreateInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInstance 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.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIntegrationAssociation

      default CompletableFuture<CreateIntegrationAssociationResponse> createIntegrationAssociation(CreateIntegrationAssociationRequest createIntegrationAssociationRequest)

      Creates an Amazon Web Services resource association with an Amazon Connect instance.

      Parameters:
      createIntegrationAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateIntegrationAssociation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createIntegrationAssociation

      default CompletableFuture<CreateIntegrationAssociationResponse> createIntegrationAssociation(Consumer<CreateIntegrationAssociationRequest.Builder> createIntegrationAssociationRequest)

      Creates an Amazon Web Services resource association with an Amazon Connect instance.


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

      Parameters:
      createIntegrationAssociationRequest - A Consumer that will call methods on CreateIntegrationAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateIntegrationAssociation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createParticipant

      default CompletableFuture<CreateParticipantResponse> createParticipant(CreateParticipantRequest createParticipantRequest)

      Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

      Parameters:
      createParticipantRequest -
      Returns:
      A Java Future containing the result of the CreateParticipant 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createParticipant

      default CompletableFuture<CreateParticipantResponse> createParticipant(Consumer<CreateParticipantRequest.Builder> createParticipantRequest)

      Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.


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

      Parameters:
      createParticipantRequest - A Consumer that will call methods on CreateParticipantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateParticipant 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPersistentContactAssociation

      default CompletableFuture<CreatePersistentContactAssociationResponse> createPersistentContactAssociation(CreatePersistentContactAssociationRequest createPersistentContactAssociationRequest)

      Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.

      Parameters:
      createPersistentContactAssociationRequest -
      Returns:
      A Java Future containing the result of the CreatePersistentContactAssociation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPersistentContactAssociation

      default CompletableFuture<CreatePersistentContactAssociationResponse> createPersistentContactAssociation(Consumer<CreatePersistentContactAssociationRequest.Builder> createPersistentContactAssociationRequest)

      Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.


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

      Parameters:
      createPersistentContactAssociationRequest - A Consumer that will call methods on CreatePersistentContactAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePersistentContactAssociation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPredefinedAttribute

      default CompletableFuture<CreatePredefinedAttributeResponse> createPredefinedAttribute(CreatePredefinedAttributeRequest createPredefinedAttributeRequest)

      Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

      Parameters:
      createPredefinedAttributeRequest -
      Returns:
      A Java Future containing the result of the CreatePredefinedAttribute 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPredefinedAttribute

      default CompletableFuture<CreatePredefinedAttributeResponse> createPredefinedAttribute(Consumer<CreatePredefinedAttributeRequest.Builder> createPredefinedAttributeRequest)

      Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.


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

      Parameters:
      createPredefinedAttributeRequest - A Consumer that will call methods on CreatePredefinedAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePredefinedAttribute 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPrompt

      default CompletableFuture<CreatePromptResponse> createPrompt(CreatePromptRequest createPromptRequest)

      Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.

      Parameters:
      createPromptRequest -
      Returns:
      A Java Future containing the result of the CreatePrompt 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPrompt

      default CompletableFuture<CreatePromptResponse> createPrompt(Consumer<CreatePromptRequest.Builder> createPromptRequest)

      Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.


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

      Parameters:
      createPromptRequest - A Consumer that will call methods on CreatePromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePrompt 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQueue

      default CompletableFuture<CreateQueueResponse> createQueue(CreateQueueRequest createQueueRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates a new queue for the specified Amazon Connect instance.

      • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

      • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

      Parameters:
      createQueueRequest -
      Returns:
      A Java Future containing the result of the CreateQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQueue

      default CompletableFuture<CreateQueueResponse> createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Creates a new queue for the specified Amazon Connect instance.

      • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

      • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.


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

      Parameters:
      createQueueRequest - A Consumer that will call methods on CreateQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuickConnect

      default CompletableFuture<CreateQuickConnectResponse> createQuickConnect(CreateQuickConnectRequest createQuickConnectRequest)

      Creates a quick connect for the specified Amazon Connect instance.

      Parameters:
      createQuickConnectRequest -
      Returns:
      A Java Future containing the result of the CreateQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuickConnect

      default CompletableFuture<CreateQuickConnectResponse> createQuickConnect(Consumer<CreateQuickConnectRequest.Builder> createQuickConnectRequest)

      Creates a quick connect for the specified Amazon Connect instance.


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

      Parameters:
      createQuickConnectRequest - A Consumer that will call methods on CreateQuickConnectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoutingProfile

      default CompletableFuture<CreateRoutingProfileResponse> createRoutingProfile(CreateRoutingProfileRequest createRoutingProfileRequest)

      Creates a new routing profile.

      Parameters:
      createRoutingProfileRequest -
      Returns:
      A Java Future containing the result of the CreateRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRoutingProfile

      default CompletableFuture<CreateRoutingProfileResponse> createRoutingProfile(Consumer<CreateRoutingProfileRequest.Builder> createRoutingProfileRequest)

      Creates a new routing profile.


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

      Parameters:
      createRoutingProfileRequest - A Consumer that will call methods on CreateRoutingProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRule

      default CompletableFuture<CreateRuleResponse> createRule(CreateRuleRequest createRuleRequest)

      Creates a rule for the specified Amazon Connect instance.

      Use the Rules Function language to code conditions for the rule.

      Parameters:
      createRuleRequest -
      Returns:
      A Java Future containing the result of the CreateRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRule

      default CompletableFuture<CreateRuleResponse> createRule(Consumer<CreateRuleRequest.Builder> createRuleRequest)

      Creates a rule for the specified Amazon Connect instance.

      Use the Rules Function language to code conditions for the rule.


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

      Parameters:
      createRuleRequest - A Consumer that will call methods on CreateRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityProfile

      default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)

      Creates a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      createSecurityProfileRequest -
      Returns:
      A Java Future containing the result of the CreateSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSecurityProfile

      default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest)

      Creates a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      createSecurityProfileRequest - A Consumer that will call methods on CreateSecurityProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTaskTemplate

      default CompletableFuture<CreateTaskTemplateResponse> createTaskTemplate(CreateTaskTemplateRequest createTaskTemplateRequest)

      Creates a new task template in the specified Amazon Connect instance.

      Parameters:
      createTaskTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateTaskTemplate 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.
      • PropertyValidationException The property is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTaskTemplate

      default CompletableFuture<CreateTaskTemplateResponse> createTaskTemplate(Consumer<CreateTaskTemplateRequest.Builder> createTaskTemplateRequest)

      Creates a new task template in the specified Amazon Connect instance.


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

      Parameters:
      createTaskTemplateRequest - A Consumer that will call methods on CreateTaskTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTaskTemplate 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.
      • PropertyValidationException The property is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrafficDistributionGroup

      default CompletableFuture<CreateTrafficDistributionGroupResponse> createTrafficDistributionGroup(CreateTrafficDistributionGroupRequest createTrafficDistributionGroupRequest)

      Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

      The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

      For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.

      Parameters:
      createTrafficDistributionGroupRequest -
      Returns:
      A Java Future containing the result of the CreateTrafficDistributionGroup 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 permissions to perform this action.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • ResourceNotReadyException The resource is not ready.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTrafficDistributionGroup

      default CompletableFuture<CreateTrafficDistributionGroupResponse> createTrafficDistributionGroup(Consumer<CreateTrafficDistributionGroupRequest.Builder> createTrafficDistributionGroupRequest)

      Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

      The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

      For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.


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

      Parameters:
      createTrafficDistributionGroupRequest - A Consumer that will call methods on CreateTrafficDistributionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTrafficDistributionGroup 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 permissions to perform this action.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • ResourceNotReadyException The resource is not ready.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUseCase

      default CompletableFuture<CreateUseCaseResponse> createUseCase(CreateUseCaseRequest createUseCaseRequest)

      Creates a use case for an integration association.

      Parameters:
      createUseCaseRequest -
      Returns:
      A Java Future containing the result of the CreateUseCase 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUseCase

      default CompletableFuture<CreateUseCaseResponse> createUseCase(Consumer<CreateUseCaseRequest.Builder> createUseCaseRequest)

      Creates a use case for an integration association.


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

      Parameters:
      createUseCaseRequest - A Consumer that will call methods on CreateUseCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUseCase 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)

      Creates a user account for the specified Amazon Connect instance.

      Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

      For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

      Parameters:
      createUserRequest -
      Returns:
      A Java Future containing the result of the CreateUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUser

      default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest)

      Creates a user account for the specified Amazon Connect instance.

      Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.

      For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.


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

      Parameters:
      createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUserHierarchyGroup

      default CompletableFuture<CreateUserHierarchyGroupResponse> createUserHierarchyGroup(CreateUserHierarchyGroupRequest createUserHierarchyGroupRequest)

      Creates a new user hierarchy group.

      Parameters:
      createUserHierarchyGroupRequest -
      Returns:
      A Java Future containing the result of the CreateUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createUserHierarchyGroup

      default CompletableFuture<CreateUserHierarchyGroupResponse> createUserHierarchyGroup(Consumer<CreateUserHierarchyGroupRequest.Builder> createUserHierarchyGroupRequest)

      Creates a new user hierarchy group.


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

      Parameters:
      createUserHierarchyGroupRequest - A Consumer that will call methods on CreateUserHierarchyGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createView

      default CompletableFuture<CreateViewResponse> createView(CreateViewRequest createViewRequest)

      Creates a new view with the possible status of SAVED or PUBLISHED.

      The views will have a unique name for each connect instance.

      It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the invalid input: '&#36'SAVED qualifier or both of the invalid input: '&#36'SAVED and invalid input: '&#36'LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

      Parameters:
      createViewRequest -
      Returns:
      A Java Future containing the result of the CreateView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • DuplicateResourceException A resource with the specified name already exists.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createView

      default CompletableFuture<CreateViewResponse> createView(Consumer<CreateViewRequest.Builder> createViewRequest)

      Creates a new view with the possible status of SAVED or PUBLISHED.

      The views will have a unique name for each connect instance.

      It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the invalid input: '&#36'SAVED qualifier or both of the invalid input: '&#36'SAVED and invalid input: '&#36'LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.


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

      Parameters:
      createViewRequest - A Consumer that will call methods on CreateViewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • DuplicateResourceException A resource with the specified name already exists.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createViewVersion

      default CompletableFuture<CreateViewVersionResponse> createViewVersion(CreateViewVersionRequest createViewVersionRequest)

      Publishes a new version of the view identifier.

      Versions are immutable and monotonically increasing.

      It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the invalid input: '&#36'LATEST alias.

      Parameters:
      createViewVersionRequest -
      Returns:
      A Java Future containing the result of the CreateViewVersion 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createViewVersion

      default CompletableFuture<CreateViewVersionResponse> createViewVersion(Consumer<CreateViewVersionRequest.Builder> createViewVersionRequest)

      Publishes a new version of the view identifier.

      Versions are immutable and monotonically increasing.

      It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the invalid input: '&#36'LATEST alias.


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

      Parameters:
      createViewVersionRequest - A Consumer that will call methods on CreateViewVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateViewVersion 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVocabulary

      default CompletableFuture<CreateVocabularyResponse> createVocabulary(CreateVocabularyRequest createVocabularyRequest)

      Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

      Parameters:
      createVocabularyRequest -
      Returns:
      A Java Future containing the result of the CreateVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createVocabulary

      default CompletableFuture<CreateVocabularyResponse> createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest)

      Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.


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

      Parameters:
      createVocabularyRequest - A Consumer that will call methods on CreateVocabularyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateEvaluationForm

      default CompletableFuture<DeactivateEvaluationFormResponse> deactivateEvaluationForm(DeactivateEvaluationFormRequest deactivateEvaluationFormRequest)

      Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

      Parameters:
      deactivateEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the DeactivateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateEvaluationForm

      default CompletableFuture<DeactivateEvaluationFormResponse> deactivateEvaluationForm(Consumer<DeactivateEvaluationFormRequest.Builder> deactivateEvaluationFormRequest)

      Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.


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

      Parameters:
      deactivateEvaluationFormRequest - A Consumer that will call methods on DeactivateEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeactivateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAttachedFile

      default CompletableFuture<DeleteAttachedFileResponse> deleteAttachedFile(DeleteAttachedFileRequest deleteAttachedFileRequest)

      Deletes an attached file along with the underlying S3 Object.

      The attached file is permanently deleted if S3 bucket versioning is not enabled.

      Parameters:
      deleteAttachedFileRequest - Request to DeleteAttachedFile API
      Returns:
      A Java Future containing the result of the DeleteAttachedFile 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAttachedFile

      default CompletableFuture<DeleteAttachedFileResponse> deleteAttachedFile(Consumer<DeleteAttachedFileRequest.Builder> deleteAttachedFileRequest)

      Deletes an attached file along with the underlying S3 Object.

      The attached file is permanently deleted if S3 bucket versioning is not enabled.


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

      Parameters:
      deleteAttachedFileRequest - A Consumer that will call methods on DeleteAttachedFileRequest.Builder to create a request. Request to DeleteAttachedFile API
      Returns:
      A Java Future containing the result of the DeleteAttachedFile 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactEvaluation

      default CompletableFuture<DeleteContactEvaluationResponse> deleteContactEvaluation(DeleteContactEvaluationRequest deleteContactEvaluationRequest)

      Deletes a contact evaluation in the specified Amazon Connect instance.

      Parameters:
      deleteContactEvaluationRequest -
      Returns:
      A Java Future containing the result of the DeleteContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactEvaluation

      default CompletableFuture<DeleteContactEvaluationResponse> deleteContactEvaluation(Consumer<DeleteContactEvaluationRequest.Builder> deleteContactEvaluationRequest)

      Deletes a contact evaluation in the specified Amazon Connect instance.


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

      Parameters:
      deleteContactEvaluationRequest - A Consumer that will call methods on DeleteContactEvaluationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactFlow

      default CompletableFuture<DeleteContactFlowResponse> deleteContactFlow(DeleteContactFlowRequest deleteContactFlowRequest)

      Deletes a flow for the specified Amazon Connect instance.

      Parameters:
      deleteContactFlowRequest -
      Returns:
      A Java Future containing the result of the DeleteContactFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactFlow

      default CompletableFuture<DeleteContactFlowResponse> deleteContactFlow(Consumer<DeleteContactFlowRequest.Builder> deleteContactFlowRequest)

      Deletes a flow for the specified Amazon Connect instance.


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

      Parameters:
      deleteContactFlowRequest - A Consumer that will call methods on DeleteContactFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContactFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactFlowModule

      default CompletableFuture<DeleteContactFlowModuleResponse> deleteContactFlowModule(DeleteContactFlowModuleRequest deleteContactFlowModuleRequest)

      Deletes the specified flow module.

      Parameters:
      deleteContactFlowModuleRequest -
      Returns:
      A Java Future containing the result of the DeleteContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactFlowModule

      default CompletableFuture<DeleteContactFlowModuleResponse> deleteContactFlowModule(Consumer<DeleteContactFlowModuleRequest.Builder> deleteContactFlowModuleRequest)

      Deletes the specified flow module.


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

      Parameters:
      deleteContactFlowModuleRequest - A Consumer that will call methods on DeleteContactFlowModuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEvaluationForm

      default CompletableFuture<DeleteEvaluationFormResponse> deleteEvaluationForm(DeleteEvaluationFormRequest deleteEvaluationFormRequest)

      Deletes an evaluation form in the specified Amazon Connect instance.

      • If the version property is provided, only the specified version of the evaluation form is deleted.

      • If no version is provided, then the full form (all versions) is deleted.

      Parameters:
      deleteEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the DeleteEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteEvaluationForm

      default CompletableFuture<DeleteEvaluationFormResponse> deleteEvaluationForm(Consumer<DeleteEvaluationFormRequest.Builder> deleteEvaluationFormRequest)

      Deletes an evaluation form in the specified Amazon Connect instance.

      • If the version property is provided, only the specified version of the evaluation form is deleted.

      • If no version is provided, then the full form (all versions) is deleted.


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

      Parameters:
      deleteEvaluationFormRequest - A Consumer that will call methods on DeleteEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHoursOfOperation

      default CompletableFuture<DeleteHoursOfOperationResponse> deleteHoursOfOperation(DeleteHoursOfOperationRequest deleteHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes an hours of operation.

      Parameters:
      deleteHoursOfOperationRequest -
      Returns:
      A Java Future containing the result of the DeleteHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHoursOfOperation

      default CompletableFuture<DeleteHoursOfOperationResponse> deleteHoursOfOperation(Consumer<DeleteHoursOfOperationRequest.Builder> deleteHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes an hours of operation.


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

      Parameters:
      deleteHoursOfOperationRequest - A Consumer that will call methods on DeleteHoursOfOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstance

      default CompletableFuture<DeleteInstanceResponse> deleteInstance(DeleteInstanceRequest deleteInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.

      Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

      Parameters:
      deleteInstanceRequest -
      Returns:
      A Java Future containing the result of the DeleteInstance 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstance

      default CompletableFuture<DeleteInstanceResponse> deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide.

      Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.


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

      Parameters:
      deleteInstanceRequest - A Consumer that will call methods on DeleteInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInstance 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIntegrationAssociation

      default CompletableFuture<DeleteIntegrationAssociationResponse> deleteIntegrationAssociation(DeleteIntegrationAssociationRequest deleteIntegrationAssociationRequest)

      Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

      Parameters:
      deleteIntegrationAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteIntegrationAssociation 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteIntegrationAssociation

      default CompletableFuture<DeleteIntegrationAssociationResponse> deleteIntegrationAssociation(Consumer<DeleteIntegrationAssociationRequest.Builder> deleteIntegrationAssociationRequest)

      Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.


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

      Parameters:
      deleteIntegrationAssociationRequest - A Consumer that will call methods on DeleteIntegrationAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteIntegrationAssociation 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePredefinedAttribute

      default CompletableFuture<DeletePredefinedAttributeResponse> deletePredefinedAttribute(DeletePredefinedAttributeRequest deletePredefinedAttributeRequest)

      Deletes a predefined attribute from the specified Amazon Connect instance.

      Parameters:
      deletePredefinedAttributeRequest -
      Returns:
      A Java Future containing the result of the DeletePredefinedAttribute 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.
      • ResourceInUseException That resource is already in use. Please try another.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePredefinedAttribute

      default CompletableFuture<DeletePredefinedAttributeResponse> deletePredefinedAttribute(Consumer<DeletePredefinedAttributeRequest.Builder> deletePredefinedAttributeRequest)

      Deletes a predefined attribute from the specified Amazon Connect instance.


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

      Parameters:
      deletePredefinedAttributeRequest - A Consumer that will call methods on DeletePredefinedAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePredefinedAttribute 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.
      • ResourceInUseException That resource is already in use. Please try another.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePrompt

      default CompletableFuture<DeletePromptResponse> deletePrompt(DeletePromptRequest deletePromptRequest)

      Deletes a prompt.

      Parameters:
      deletePromptRequest -
      Returns:
      A Java Future containing the result of the DeletePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePrompt

      default CompletableFuture<DeletePromptResponse> deletePrompt(Consumer<DeletePromptRequest.Builder> deletePromptRequest)

      Deletes a prompt.


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

      Parameters:
      deletePromptRequest - A Consumer that will call methods on DeletePromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQueue

      default CompletableFuture<DeleteQueueResponse> deleteQueue(DeleteQueueRequest deleteQueueRequest)

      Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.

      Parameters:
      deleteQueueRequest -
      Returns:
      A Java Future containing the result of the DeleteQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQueue

      default CompletableFuture<DeleteQueueResponse> deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)

      Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.


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

      Parameters:
      deleteQueueRequest - A Consumer that will call methods on DeleteQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuickConnect

      default CompletableFuture<DeleteQuickConnectResponse> deleteQuickConnect(DeleteQuickConnectRequest deleteQuickConnectRequest)

      Deletes a quick connect.

      After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

      • Avoid dangling resources that impact your service quotas.

      • Remove deleted users so they don't appear to agents as transfer options.

      • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

      Parameters:
      deleteQuickConnectRequest -
      Returns:
      A Java Future containing the result of the DeleteQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuickConnect

      default CompletableFuture<DeleteQuickConnectResponse> deleteQuickConnect(Consumer<DeleteQuickConnectRequest.Builder> deleteQuickConnectRequest)

      Deletes a quick connect.

      After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

      • Avoid dangling resources that impact your service quotas.

      • Remove deleted users so they don't appear to agents as transfer options.

      • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.


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

      Parameters:
      deleteQuickConnectRequest - A Consumer that will call methods on DeleteQuickConnectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoutingProfile

      default CompletableFuture<DeleteRoutingProfileResponse> deleteRoutingProfile(DeleteRoutingProfileRequest deleteRoutingProfileRequest)

      Deletes a routing profile.

      Parameters:
      deleteRoutingProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRoutingProfile

      default CompletableFuture<DeleteRoutingProfileResponse> deleteRoutingProfile(Consumer<DeleteRoutingProfileRequest.Builder> deleteRoutingProfileRequest)

      Deletes a routing profile.


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

      Parameters:
      deleteRoutingProfileRequest - A Consumer that will call methods on DeleteRoutingProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRule

      default CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest deleteRuleRequest)

      Deletes a rule for the specified Amazon Connect instance.

      Parameters:
      deleteRuleRequest -
      Returns:
      A Java Future containing the result of the DeleteRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRule

      default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)

      Deletes a rule for the specified Amazon Connect instance.


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

      Parameters:
      deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityProfile

      default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)

      Deletes a security profile.

      Parameters:
      deleteSecurityProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSecurityProfile

      default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest)

      Deletes a security profile.


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

      Parameters:
      deleteSecurityProfileRequest - A Consumer that will call methods on DeleteSecurityProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTaskTemplate

      default CompletableFuture<DeleteTaskTemplateResponse> deleteTaskTemplate(DeleteTaskTemplateRequest deleteTaskTemplateRequest)

      Deletes the task template.

      Parameters:
      deleteTaskTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteTaskTemplate 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTaskTemplate

      default CompletableFuture<DeleteTaskTemplateResponse> deleteTaskTemplate(Consumer<DeleteTaskTemplateRequest.Builder> deleteTaskTemplateRequest)

      Deletes the task template.


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

      Parameters:
      deleteTaskTemplateRequest - A Consumer that will call methods on DeleteTaskTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTaskTemplate 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrafficDistributionGroup

      default CompletableFuture<DeleteTrafficDistributionGroupResponse> deleteTrafficDistributionGroup(DeleteTrafficDistributionGroupRequest deleteTrafficDistributionGroupRequest)

      Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

      For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

      Parameters:
      deleteTrafficDistributionGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteTrafficDistributionGroup 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 permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTrafficDistributionGroup

      default CompletableFuture<DeleteTrafficDistributionGroupResponse> deleteTrafficDistributionGroup(Consumer<DeleteTrafficDistributionGroupRequest.Builder> deleteTrafficDistributionGroupRequest)

      Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

      For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.


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

      Parameters:
      deleteTrafficDistributionGroupRequest - A Consumer that will call methods on DeleteTrafficDistributionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTrafficDistributionGroup 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 permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUseCase

      default CompletableFuture<DeleteUseCaseResponse> deleteUseCase(DeleteUseCaseRequest deleteUseCaseRequest)

      Deletes a use case from an integration association.

      Parameters:
      deleteUseCaseRequest -
      Returns:
      A Java Future containing the result of the DeleteUseCase 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUseCase

      default CompletableFuture<DeleteUseCaseResponse> deleteUseCase(Consumer<DeleteUseCaseRequest.Builder> deleteUseCaseRequest)

      Deletes a use case from an integration association.


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

      Parameters:
      deleteUseCaseRequest - A Consumer that will call methods on DeleteUseCaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUseCase 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(DeleteUserRequest deleteUserRequest)

      Deletes a user account from the specified Amazon Connect instance.

      For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

      After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

      • Avoid dangling resources that impact your service quotas.

      • Remove deleted users so they don't appear to agents as transfer options.

      • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

      Parameters:
      deleteUserRequest -
      Returns:
      A Java Future containing the result of the DeleteUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUser

      default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

      Deletes a user account from the specified Amazon Connect instance.

      For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

      After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

      • Avoid dangling resources that impact your service quotas.

      • Remove deleted users so they don't appear to agents as transfer options.

      • Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.


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

      Parameters:
      deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserHierarchyGroup

      default CompletableFuture<DeleteUserHierarchyGroupResponse> deleteUserHierarchyGroup(DeleteUserHierarchyGroupRequest deleteUserHierarchyGroupRequest)

      Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

      Parameters:
      deleteUserHierarchyGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteUserHierarchyGroup

      default CompletableFuture<DeleteUserHierarchyGroupResponse> deleteUserHierarchyGroup(Consumer<DeleteUserHierarchyGroupRequest.Builder> deleteUserHierarchyGroupRequest)

      Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.


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

      Parameters:
      deleteUserHierarchyGroupRequest - A Consumer that will call methods on DeleteUserHierarchyGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteView

      default CompletableFuture<DeleteViewResponse> deleteView(DeleteViewRequest deleteViewRequest)

      Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

      Parameters:
      deleteViewRequest -
      Returns:
      A Java Future containing the result of the DeleteView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteView

      default CompletableFuture<DeleteViewResponse> deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest)

      Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).


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

      Parameters:
      deleteViewRequest - A Consumer that will call methods on DeleteViewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteViewVersion

      default CompletableFuture<DeleteViewVersionResponse> deleteViewVersion(DeleteViewVersionRequest deleteViewVersionRequest)

      Deletes the particular version specified in ViewVersion identifier.

      Parameters:
      deleteViewVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteViewVersion 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteViewVersion

      default CompletableFuture<DeleteViewVersionResponse> deleteViewVersion(Consumer<DeleteViewVersionRequest.Builder> deleteViewVersionRequest)

      Deletes the particular version specified in ViewVersion identifier.


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

      Parameters:
      deleteViewVersionRequest - A Consumer that will call methods on DeleteViewVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteViewVersion 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVocabulary

      default CompletableFuture<DeleteVocabularyResponse> deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)

      Deletes the vocabulary that has the given identifier.

      Parameters:
      deleteVocabularyRequest -
      Returns:
      A Java Future containing the result of the DeleteVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteVocabulary

      default CompletableFuture<DeleteVocabularyResponse> deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest)

      Deletes the vocabulary that has the given identifier.


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

      Parameters:
      deleteVocabularyRequest - A Consumer that will call methods on DeleteVocabularyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAgentStatus

      default CompletableFuture<DescribeAgentStatusResponse> describeAgentStatus(DescribeAgentStatusRequest describeAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes an agent status.

      Parameters:
      describeAgentStatusRequest -
      Returns:
      A Java Future containing the result of the DescribeAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAgentStatus

      default CompletableFuture<DescribeAgentStatusResponse> describeAgentStatus(Consumer<DescribeAgentStatusRequest.Builder> describeAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes an agent status.


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

      Parameters:
      describeAgentStatusRequest - A Consumer that will call methods on DescribeAgentStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAuthenticationProfile

      default CompletableFuture<DescribeAuthenticationProfileResponse> describeAuthenticationProfile(DescribeAuthenticationProfileRequest describeAuthenticationProfileRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Describes the target authentication profile.

      Parameters:
      describeAuthenticationProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeAuthenticationProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAuthenticationProfile

      default CompletableFuture<DescribeAuthenticationProfileResponse> describeAuthenticationProfile(Consumer<DescribeAuthenticationProfileRequest.Builder> describeAuthenticationProfileRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Describes the target authentication profile.


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

      Parameters:
      describeAuthenticationProfileRequest - A Consumer that will call methods on DescribeAuthenticationProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAuthenticationProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContact

      default CompletableFuture<DescribeContactResponse> describeContact(DescribeContactRequest describeContactRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified contact.

      Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API

      Parameters:
      describeContactRequest -
      Returns:
      A Java Future containing the result of the DescribeContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContact

      default CompletableFuture<DescribeContactResponse> describeContact(Consumer<DescribeContactRequest.Builder> describeContactRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified contact.

      Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API


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

      Parameters:
      describeContactRequest - A Consumer that will call methods on DescribeContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactEvaluation

      default CompletableFuture<DescribeContactEvaluationResponse> describeContactEvaluation(DescribeContactEvaluationRequest describeContactEvaluationRequest)

      Describes a contact evaluation in the specified Amazon Connect instance.

      Parameters:
      describeContactEvaluationRequest -
      Returns:
      A Java Future containing the result of the DescribeContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactEvaluation

      default CompletableFuture<DescribeContactEvaluationResponse> describeContactEvaluation(Consumer<DescribeContactEvaluationRequest.Builder> describeContactEvaluationRequest)

      Describes a contact evaluation in the specified Amazon Connect instance.


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

      Parameters:
      describeContactEvaluationRequest - A Consumer that will call methods on DescribeContactEvaluationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactFlow

      default CompletableFuture<DescribeContactFlowResponse> describeContactFlow(DescribeContactFlowRequest describeContactFlowRequest)

      Describes the specified flow.

      You can also create and update flows using the Amazon Connect Flow language.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.

      In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

      Parameters:
      describeContactFlowRequest -
      Returns:
      A Java Future containing the result of the DescribeContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ContactFlowNotPublishedException The flow has not been published.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactFlow

      default CompletableFuture<DescribeContactFlowResponse> describeContactFlow(Consumer<DescribeContactFlowRequest.Builder> describeContactFlowRequest)

      Describes the specified flow.

      You can also create and update flows using the Amazon Connect Flow language.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.

      In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED


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

      Parameters:
      describeContactFlowRequest - A Consumer that will call methods on DescribeContactFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ContactFlowNotPublishedException The flow has not been published.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactFlowModule

      default CompletableFuture<DescribeContactFlowModuleResponse> describeContactFlowModule(DescribeContactFlowModuleRequest describeContactFlowModuleRequest)

      Describes the specified flow module.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.

      Parameters:
      describeContactFlowModuleRequest -
      Returns:
      A Java Future containing the result of the DescribeContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeContactFlowModule

      default CompletableFuture<DescribeContactFlowModuleResponse> describeContactFlowModule(Consumer<DescribeContactFlowModuleRequest.Builder> describeContactFlowModuleRequest)

      Describes the specified flow module.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.


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

      Parameters:
      describeContactFlowModuleRequest - A Consumer that will call methods on DescribeContactFlowModuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContactFlowModule 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvaluationForm

      default CompletableFuture<DescribeEvaluationFormResponse> describeEvaluationForm(DescribeEvaluationFormRequest describeEvaluationFormRequest)

      Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

      Parameters:
      describeEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the DescribeEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeEvaluationForm

      default CompletableFuture<DescribeEvaluationFormResponse> describeEvaluationForm(Consumer<DescribeEvaluationFormRequest.Builder> describeEvaluationFormRequest)

      Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.


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

      Parameters:
      describeEvaluationFormRequest - A Consumer that will call methods on DescribeEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHoursOfOperation

      default CompletableFuture<DescribeHoursOfOperationResponse> describeHoursOfOperation(DescribeHoursOfOperationRequest describeHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the hours of operation.

      Parameters:
      describeHoursOfOperationRequest -
      Returns:
      A Java Future containing the result of the DescribeHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHoursOfOperation

      default CompletableFuture<DescribeHoursOfOperationResponse> describeHoursOfOperation(Consumer<DescribeHoursOfOperationRequest.Builder> describeHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the hours of operation.


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

      Parameters:
      describeHoursOfOperationRequest - A Consumer that will call methods on DescribeHoursOfOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstance

      default CompletableFuture<DescribeInstanceResponse> describeInstance(DescribeInstanceRequest describeInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

      If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

      Parameters:
      describeInstanceRequest -
      Returns:
      A Java Future containing the result of the DescribeInstance 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstance

      default CompletableFuture<DescribeInstanceResponse> describeInstance(Consumer<DescribeInstanceRequest.Builder> describeInstanceRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.

      If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.


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

      Parameters:
      describeInstanceRequest - A Consumer that will call methods on DescribeInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInstance 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAttribute

      default CompletableFuture<DescribeInstanceAttributeResponse> describeInstanceAttribute(DescribeInstanceAttributeRequest describeInstanceAttributeRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified instance attribute.

      Parameters:
      describeInstanceAttributeRequest -
      Returns:
      A Java Future containing the result of the DescribeInstanceAttribute 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceAttribute

      default CompletableFuture<DescribeInstanceAttributeResponse> describeInstanceAttribute(Consumer<DescribeInstanceAttributeRequest.Builder> describeInstanceAttributeRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified instance attribute.


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

      Parameters:
      describeInstanceAttributeRequest - A Consumer that will call methods on DescribeInstanceAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInstanceAttribute 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceStorageConfig

      default CompletableFuture<DescribeInstanceStorageConfigResponse> describeInstanceStorageConfig(DescribeInstanceStorageConfigRequest describeInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

      Parameters:
      describeInstanceStorageConfigRequest -
      Returns:
      A Java Future containing the result of the DescribeInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeInstanceStorageConfig

      default CompletableFuture<DescribeInstanceStorageConfigResponse> describeInstanceStorageConfig(Consumer<DescribeInstanceStorageConfigRequest.Builder> describeInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.


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

      Parameters:
      describeInstanceStorageConfigRequest - A Consumer that will call methods on DescribeInstanceStorageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePhoneNumber

      default CompletableFuture<DescribePhoneNumberResponse> describePhoneNumber(DescribePhoneNumberRequest describePhoneNumberRequest)

      Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

      If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      Parameters:
      describePhoneNumberRequest -
      Returns:
      A Java Future containing the result of the DescribePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePhoneNumber

      default CompletableFuture<DescribePhoneNumberResponse> describePhoneNumber(Consumer<DescribePhoneNumberRequest.Builder> describePhoneNumberRequest)

      Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

      If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.


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

      Parameters:
      describePhoneNumberRequest - A Consumer that will call methods on DescribePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePredefinedAttribute

      default CompletableFuture<DescribePredefinedAttributeResponse> describePredefinedAttribute(DescribePredefinedAttributeRequest describePredefinedAttributeRequest)

      Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

      Parameters:
      describePredefinedAttributeRequest -
      Returns:
      A Java Future containing the result of the DescribePredefinedAttribute 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePredefinedAttribute

      default CompletableFuture<DescribePredefinedAttributeResponse> describePredefinedAttribute(Consumer<DescribePredefinedAttributeRequest.Builder> describePredefinedAttributeRequest)

      Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.


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

      Parameters:
      describePredefinedAttributeRequest - A Consumer that will call methods on DescribePredefinedAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePredefinedAttribute 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePrompt

      default CompletableFuture<DescribePromptResponse> describePrompt(DescribePromptRequest describePromptRequest)

      Describes the prompt.

      Parameters:
      describePromptRequest -
      Returns:
      A Java Future containing the result of the DescribePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describePrompt

      default CompletableFuture<DescribePromptResponse> describePrompt(Consumer<DescribePromptRequest.Builder> describePromptRequest)

      Describes the prompt.


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

      Parameters:
      describePromptRequest - A Consumer that will call methods on DescribePromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQueue

      default CompletableFuture<DescribeQueueResponse> describeQueue(DescribeQueueRequest describeQueueRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified queue.

      Parameters:
      describeQueueRequest -
      Returns:
      A Java Future containing the result of the DescribeQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQueue

      default CompletableFuture<DescribeQueueResponse> describeQueue(Consumer<DescribeQueueRequest.Builder> describeQueueRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Describes the specified queue.


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

      Parameters:
      describeQueueRequest - A Consumer that will call methods on DescribeQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuickConnect

      default CompletableFuture<DescribeQuickConnectResponse> describeQuickConnect(DescribeQuickConnectRequest describeQuickConnectRequest)

      Describes the quick connect.

      Parameters:
      describeQuickConnectRequest -
      Returns:
      A Java Future containing the result of the DescribeQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQuickConnect

      default CompletableFuture<DescribeQuickConnectResponse> describeQuickConnect(Consumer<DescribeQuickConnectRequest.Builder> describeQuickConnectRequest)

      Describes the quick connect.


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

      Parameters:
      describeQuickConnectRequest - A Consumer that will call methods on DescribeQuickConnectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQuickConnect 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRoutingProfile

      default CompletableFuture<DescribeRoutingProfileResponse> describeRoutingProfile(DescribeRoutingProfileRequest describeRoutingProfileRequest)

      Describes the specified routing profile.

      Parameters:
      describeRoutingProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRoutingProfile

      default CompletableFuture<DescribeRoutingProfileResponse> describeRoutingProfile(Consumer<DescribeRoutingProfileRequest.Builder> describeRoutingProfileRequest)

      Describes the specified routing profile.


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

      Parameters:
      describeRoutingProfileRequest - A Consumer that will call methods on DescribeRoutingProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRule

      default CompletableFuture<DescribeRuleResponse> describeRule(DescribeRuleRequest describeRuleRequest)

      Describes a rule for the specified Amazon Connect instance.

      Parameters:
      describeRuleRequest -
      Returns:
      A Java Future containing the result of the DescribeRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeRule

      default CompletableFuture<DescribeRuleResponse> describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)

      Describes a rule for the specified Amazon Connect instance.


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

      Parameters:
      describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSecurityProfile

      default CompletableFuture<DescribeSecurityProfileResponse> describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)

      Gets basic information about the security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      describeSecurityProfileRequest -
      Returns:
      A Java Future containing the result of the DescribeSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeSecurityProfile

      default CompletableFuture<DescribeSecurityProfileResponse> describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest)

      Gets basic information about the security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      describeSecurityProfileRequest - A Consumer that will call methods on DescribeSecurityProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrafficDistributionGroup

      default CompletableFuture<DescribeTrafficDistributionGroupResponse> describeTrafficDistributionGroup(DescribeTrafficDistributionGroupRequest describeTrafficDistributionGroupRequest)

      Gets details and status of a traffic distribution group.

      Parameters:
      describeTrafficDistributionGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeTrafficDistributionGroup 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTrafficDistributionGroup

      default CompletableFuture<DescribeTrafficDistributionGroupResponse> describeTrafficDistributionGroup(Consumer<DescribeTrafficDistributionGroupRequest.Builder> describeTrafficDistributionGroupRequest)

      Gets details and status of a traffic distribution group.


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

      Parameters:
      describeTrafficDistributionGroupRequest - A Consumer that will call methods on DescribeTrafficDistributionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTrafficDistributionGroup 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUser

      default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest)

      Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

      Parameters:
      describeUserRequest -
      Returns:
      A Java Future containing the result of the DescribeUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUser

      default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)

      Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.


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

      Parameters:
      describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUser 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserHierarchyGroup

      default CompletableFuture<DescribeUserHierarchyGroupResponse> describeUserHierarchyGroup(DescribeUserHierarchyGroupRequest describeUserHierarchyGroupRequest)

      Describes the specified hierarchy group.

      Parameters:
      describeUserHierarchyGroupRequest -
      Returns:
      A Java Future containing the result of the DescribeUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserHierarchyGroup

      default CompletableFuture<DescribeUserHierarchyGroupResponse> describeUserHierarchyGroup(Consumer<DescribeUserHierarchyGroupRequest.Builder> describeUserHierarchyGroupRequest)

      Describes the specified hierarchy group.


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

      Parameters:
      describeUserHierarchyGroupRequest - A Consumer that will call methods on DescribeUserHierarchyGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUserHierarchyGroup 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserHierarchyStructure

      default CompletableFuture<DescribeUserHierarchyStructureResponse> describeUserHierarchyStructure(DescribeUserHierarchyStructureRequest describeUserHierarchyStructureRequest)

      Describes the hierarchy structure of the specified Amazon Connect instance.

      Parameters:
      describeUserHierarchyStructureRequest -
      Returns:
      A Java Future containing the result of the DescribeUserHierarchyStructure 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeUserHierarchyStructure

      default CompletableFuture<DescribeUserHierarchyStructureResponse> describeUserHierarchyStructure(Consumer<DescribeUserHierarchyStructureRequest.Builder> describeUserHierarchyStructureRequest)

      Describes the hierarchy structure of the specified Amazon Connect instance.


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

      Parameters:
      describeUserHierarchyStructureRequest - A Consumer that will call methods on DescribeUserHierarchyStructureRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeUserHierarchyStructure 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeView

      default CompletableFuture<DescribeViewResponse> describeView(DescribeViewRequest describeViewRequest)

      Retrieves the view for the specified Amazon Connect instance and view identifier.

      The view identifier can be supplied as a ViewId or ARN.

      invalid input: '&#36'SAVED needs to be supplied if a view is unpublished.

      The view identifier can contain an optional qualifier, for example, <view-id>:invalid input: '&#36'SAVED, which is either an actual version number or an Amazon Connect managed qualifier invalid input: '&#36'SAVED | invalid input: '&#36'LATEST. If it is not supplied, then invalid input: '&#36'LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

      Parameters:
      describeViewRequest -
      Returns:
      A Java Future containing the result of the DescribeView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeView

      default CompletableFuture<DescribeViewResponse> describeView(Consumer<DescribeViewRequest.Builder> describeViewRequest)

      Retrieves the view for the specified Amazon Connect instance and view identifier.

      The view identifier can be supplied as a ViewId or ARN.

      invalid input: '&#36'SAVED needs to be supplied if a view is unpublished.

      The view identifier can contain an optional qualifier, for example, <view-id>:invalid input: '&#36'SAVED, which is either an actual version number or an Amazon Connect managed qualifier invalid input: '&#36'SAVED | invalid input: '&#36'LATEST. If it is not supplied, then invalid input: '&#36'LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.


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

      Parameters:
      describeViewRequest - A Consumer that will call methods on DescribeViewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeView 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVocabulary

      default CompletableFuture<DescribeVocabularyResponse> describeVocabulary(DescribeVocabularyRequest describeVocabularyRequest)

      Describes the specified vocabulary.

      Parameters:
      describeVocabularyRequest -
      Returns:
      A Java Future containing the result of the DescribeVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeVocabulary

      default CompletableFuture<DescribeVocabularyResponse> describeVocabulary(Consumer<DescribeVocabularyRequest.Builder> describeVocabularyRequest)

      Describes the specified vocabulary.


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

      Parameters:
      describeVocabularyRequest - A Consumer that will call methods on DescribeVocabularyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeVocabulary 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAnalyticsDataSet

      default CompletableFuture<DisassociateAnalyticsDataSetResponse> disassociateAnalyticsDataSet(DisassociateAnalyticsDataSetRequest disassociateAnalyticsDataSetRequest)

      Removes the dataset ID associated with a given Amazon Connect instance.

      Parameters:
      disassociateAnalyticsDataSetRequest -
      Returns:
      A Java Future containing the result of the DisassociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAnalyticsDataSet

      default CompletableFuture<DisassociateAnalyticsDataSetResponse> disassociateAnalyticsDataSet(Consumer<DisassociateAnalyticsDataSetRequest.Builder> disassociateAnalyticsDataSetRequest)

      Removes the dataset ID associated with a given Amazon Connect instance.


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

      Parameters:
      disassociateAnalyticsDataSetRequest - A Consumer that will call methods on DisassociateAnalyticsDataSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateAnalyticsDataSet 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateApprovedOrigin

      default CompletableFuture<DisassociateApprovedOriginResponse> disassociateApprovedOrigin(DisassociateApprovedOriginRequest disassociateApprovedOriginRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes access to integrated applications from Amazon Connect.

      Parameters:
      disassociateApprovedOriginRequest -
      Returns:
      A Java Future containing the result of the DisassociateApprovedOrigin 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateApprovedOrigin

      default CompletableFuture<DisassociateApprovedOriginResponse> disassociateApprovedOrigin(Consumer<DisassociateApprovedOriginRequest.Builder> disassociateApprovedOriginRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes access to integrated applications from Amazon Connect.


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

      Parameters:
      disassociateApprovedOriginRequest - A Consumer that will call methods on DisassociateApprovedOriginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateApprovedOrigin 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateBot

      default CompletableFuture<DisassociateBotResponse> disassociateBot(DisassociateBotRequest disassociateBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

      Parameters:
      disassociateBotRequest -
      Returns:
      A Java Future containing the result of the DisassociateBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateBot

      default CompletableFuture<DisassociateBotResponse> disassociateBot(Consumer<DisassociateBotRequest.Builder> disassociateBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.


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

      Parameters:
      disassociateBotRequest - A Consumer that will call methods on DisassociateBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFlow

      default CompletableFuture<DisassociateFlowResponse> disassociateFlow(DisassociateFlowRequest disassociateFlowRequest)

      Disassociates a connect resource from a flow.

      Parameters:
      disassociateFlowRequest -
      Returns:
      A Java Future containing the result of the DisassociateFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateFlow

      default CompletableFuture<DisassociateFlowResponse> disassociateFlow(Consumer<DisassociateFlowRequest.Builder> disassociateFlowRequest)

      Disassociates a connect resource from a flow.


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

      Parameters:
      disassociateFlowRequest - A Consumer that will call methods on DisassociateFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateFlow 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateInstanceStorageConfig

      default CompletableFuture<DisassociateInstanceStorageConfigResponse> disassociateInstanceStorageConfig(DisassociateInstanceStorageConfigRequest disassociateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Removes the storage type configurations for the specified resource type and association ID.

      Parameters:
      disassociateInstanceStorageConfigRequest -
      Returns:
      A Java Future containing the result of the DisassociateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateInstanceStorageConfig

      default CompletableFuture<DisassociateInstanceStorageConfigResponse> disassociateInstanceStorageConfig(Consumer<DisassociateInstanceStorageConfigRequest.Builder> disassociateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Removes the storage type configurations for the specified resource type and association ID.


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

      Parameters:
      disassociateInstanceStorageConfigRequest - A Consumer that will call methods on DisassociateInstanceStorageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLambdaFunction

      default CompletableFuture<DisassociateLambdaFunctionResponse> disassociateLambdaFunction(DisassociateLambdaFunctionRequest disassociateLambdaFunctionRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Remove the Lambda function from the dropdown options available in the relevant flow blocks.

      Parameters:
      disassociateLambdaFunctionRequest -
      Returns:
      A Java Future containing the result of the DisassociateLambdaFunction 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLambdaFunction

      default CompletableFuture<DisassociateLambdaFunctionResponse> disassociateLambdaFunction(Consumer<DisassociateLambdaFunctionRequest.Builder> disassociateLambdaFunctionRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Remove the Lambda function from the dropdown options available in the relevant flow blocks.


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

      Parameters:
      disassociateLambdaFunctionRequest - A Consumer that will call methods on DisassociateLambdaFunctionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateLambdaFunction 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLexBot

      default CompletableFuture<DisassociateLexBotResponse> disassociateLexBot(DisassociateLexBotRequest disassociateLexBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes authorization from the specified instance to access the specified Amazon Lex bot.

      Parameters:
      disassociateLexBotRequest -
      Returns:
      A Java Future containing the result of the DisassociateLexBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLexBot

      default CompletableFuture<DisassociateLexBotResponse> disassociateLexBot(Consumer<DisassociateLexBotRequest.Builder> disassociateLexBotRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Revokes authorization from the specified instance to access the specified Amazon Lex bot.


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

      Parameters:
      disassociateLexBotRequest - A Consumer that will call methods on DisassociateLexBotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateLexBot 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePhoneNumberContactFlow

      default CompletableFuture<DisassociatePhoneNumberContactFlowResponse> disassociatePhoneNumberContactFlow(DisassociatePhoneNumberContactFlowRequest disassociatePhoneNumberContactFlowRequest)

      Removes the flow association from a phone number claimed to your Amazon Connect instance.

      If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      Parameters:
      disassociatePhoneNumberContactFlowRequest -
      Returns:
      A Java Future containing the result of the DisassociatePhoneNumberContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociatePhoneNumberContactFlow

      default CompletableFuture<DisassociatePhoneNumberContactFlowResponse> disassociatePhoneNumberContactFlow(Consumer<DisassociatePhoneNumberContactFlowRequest.Builder> disassociatePhoneNumberContactFlowRequest)

      Removes the flow association from a phone number claimed to your Amazon Connect instance.

      If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.


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

      Parameters:
      disassociatePhoneNumberContactFlowRequest - A Consumer that will call methods on DisassociatePhoneNumberContactFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociatePhoneNumberContactFlow 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateQueueQuickConnects

      default CompletableFuture<DisassociateQueueQuickConnectsResponse> disassociateQueueQuickConnects(DisassociateQueueQuickConnectsRequest disassociateQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Disassociates a set of quick connects from a queue.

      Parameters:
      disassociateQueueQuickConnectsRequest -
      Returns:
      A Java Future containing the result of the DisassociateQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateQueueQuickConnects

      default CompletableFuture<DisassociateQueueQuickConnectsResponse> disassociateQueueQuickConnects(Consumer<DisassociateQueueQuickConnectsRequest.Builder> disassociateQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Disassociates a set of quick connects from a queue.


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

      Parameters:
      disassociateQueueQuickConnectsRequest - A Consumer that will call methods on DisassociateQueueQuickConnectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRoutingProfileQueues

      default CompletableFuture<DisassociateRoutingProfileQueuesResponse> disassociateRoutingProfileQueues(DisassociateRoutingProfileQueuesRequest disassociateRoutingProfileQueuesRequest)

      Disassociates a set of queues from a routing profile.

      Parameters:
      disassociateRoutingProfileQueuesRequest -
      Returns:
      A Java Future containing the result of the DisassociateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateRoutingProfileQueues

      default CompletableFuture<DisassociateRoutingProfileQueuesResponse> disassociateRoutingProfileQueues(Consumer<DisassociateRoutingProfileQueuesRequest.Builder> disassociateRoutingProfileQueuesRequest)

      Disassociates a set of queues from a routing profile.


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

      Parameters:
      disassociateRoutingProfileQueuesRequest - A Consumer that will call methods on DisassociateRoutingProfileQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateSecurityKey

      default CompletableFuture<DisassociateSecurityKeyResponse> disassociateSecurityKey(DisassociateSecurityKeyRequest disassociateSecurityKeyRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes the specified security key.

      Parameters:
      disassociateSecurityKeyRequest -
      Returns:
      A Java Future containing the result of the DisassociateSecurityKey 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateSecurityKey

      default CompletableFuture<DisassociateSecurityKeyResponse> disassociateSecurityKey(Consumer<DisassociateSecurityKeyRequest.Builder> disassociateSecurityKeyRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Deletes the specified security key.


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

      Parameters:
      disassociateSecurityKeyRequest - A Consumer that will call methods on DisassociateSecurityKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateSecurityKey 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTrafficDistributionGroupUser

      default CompletableFuture<DisassociateTrafficDistributionGroupUserResponse> disassociateTrafficDistributionGroupUser(DisassociateTrafficDistributionGroupUserRequest disassociateTrafficDistributionGroupUserRequest)

      Disassociates an agent from a traffic distribution group.

      Parameters:
      disassociateTrafficDistributionGroupUserRequest -
      Returns:
      A Java Future containing the result of the DisassociateTrafficDistributionGroupUser 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateTrafficDistributionGroupUser

      default CompletableFuture<DisassociateTrafficDistributionGroupUserResponse> disassociateTrafficDistributionGroupUser(Consumer<DisassociateTrafficDistributionGroupUserRequest.Builder> disassociateTrafficDistributionGroupUserRequest)

      Disassociates an agent from a traffic distribution group.


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

      Parameters:
      disassociateTrafficDistributionGroupUserRequest - A Consumer that will call methods on DisassociateTrafficDistributionGroupUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateTrafficDistributionGroupUser 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateUserProficiencies

      default CompletableFuture<DisassociateUserProficienciesResponse> disassociateUserProficiencies(DisassociateUserProficienciesRequest disassociateUserProficienciesRequest)

      Disassociates a set of proficiencies from a user.

      Parameters:
      disassociateUserProficienciesRequest -
      Returns:
      A Java Future containing the result of the DisassociateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateUserProficiencies

      default CompletableFuture<DisassociateUserProficienciesResponse> disassociateUserProficiencies(Consumer<DisassociateUserProficienciesRequest.Builder> disassociateUserProficienciesRequest)

      Disassociates a set of proficiencies from a user.


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

      Parameters:
      disassociateUserProficienciesRequest - A Consumer that will call methods on DisassociateUserProficienciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dismissUserContact

      default CompletableFuture<DismissUserContactResponse> dismissUserContact(DismissUserContactRequest dismissUserContactRequest)

      Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

      Parameters:
      dismissUserContactRequest -
      Returns:
      A Java Future containing the result of the DismissUserContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • dismissUserContact

      default CompletableFuture<DismissUserContactResponse> dismissUserContact(Consumer<DismissUserContactRequest.Builder> dismissUserContactRequest)

      Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.


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

      Parameters:
      dismissUserContactRequest - A Consumer that will call methods on DismissUserContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DismissUserContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAttachedFile

      default CompletableFuture<GetAttachedFileResponse> getAttachedFile(GetAttachedFileRequest getAttachedFileRequest)

      Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

      Parameters:
      getAttachedFileRequest - Request to GetAttachedFile API.
      Returns:
      A Java Future containing the result of the GetAttachedFile 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAttachedFile

      default CompletableFuture<GetAttachedFileResponse> getAttachedFile(Consumer<GetAttachedFileRequest.Builder> getAttachedFileRequest)

      Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.


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

      Parameters:
      getAttachedFileRequest - A Consumer that will call methods on GetAttachedFileRequest.Builder to create a request. Request to GetAttachedFile API.
      Returns:
      A Java Future containing the result of the GetAttachedFile 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactAttributes

      default CompletableFuture<GetContactAttributesResponse> getContactAttributes(GetContactAttributesRequest getContactAttributesRequest)

      Retrieves the contact attributes for the specified contact.

      Parameters:
      getContactAttributesRequest -
      Returns:
      A Java Future containing the result of the GetContactAttributes 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactAttributes

      default CompletableFuture<GetContactAttributesResponse> getContactAttributes(Consumer<GetContactAttributesRequest.Builder> getContactAttributesRequest)

      Retrieves the contact attributes for the specified contact.


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

      Parameters:
      getContactAttributesRequest - A Consumer that will call methods on GetContactAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContactAttributes 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentMetricData

      default CompletableFuture<GetCurrentMetricDataResponse> getCurrentMetricData(GetCurrentMetricDataRequest getCurrentMetricDataRequest)

      Gets the real-time metric data from the specified Amazon Connect instance.

      For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

      Parameters:
      getCurrentMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetCurrentMetricData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentMetricData

      default CompletableFuture<GetCurrentMetricDataResponse> getCurrentMetricData(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)

      Gets the real-time metric data from the specified Amazon Connect instance.

      For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.


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

      Parameters:
      getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCurrentMetricData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentMetricDataPaginator

      default GetCurrentMetricDataPublisher getCurrentMetricDataPaginator(GetCurrentMetricDataRequest getCurrentMetricDataRequest)

      This is a variant of getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) 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.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse 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 getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation.

      Parameters:
      getCurrentMetricDataRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentMetricDataPaginator

      default GetCurrentMetricDataPublisher getCurrentMetricDataPaginator(Consumer<GetCurrentMetricDataRequest.Builder> getCurrentMetricDataRequest)

      This is a variant of getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) 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.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetCurrentMetricDataPublisher publisher = client.getCurrentMetricDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataResponse 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 getCurrentMetricData(software.amazon.awssdk.services.connect.model.GetCurrentMetricDataRequest) operation.


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

      Parameters:
      getCurrentMetricDataRequest - A Consumer that will call methods on GetCurrentMetricDataRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentUserData

      default CompletableFuture<GetCurrentUserDataResponse> getCurrentUserData(GetCurrentUserDataRequest getCurrentUserDataRequest)

      Gets the real-time active user data from the specified Amazon Connect instance.

      Parameters:
      getCurrentUserDataRequest -
      Returns:
      A Java Future containing the result of the GetCurrentUserData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentUserData

      default CompletableFuture<GetCurrentUserDataResponse> getCurrentUserData(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest)

      Gets the real-time active user data from the specified Amazon Connect instance.


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

      Parameters:
      getCurrentUserDataRequest - A Consumer that will call methods on GetCurrentUserDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCurrentUserData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentUserDataPaginator

      default GetCurrentUserDataPublisher getCurrentUserDataPaginator(GetCurrentUserDataRequest getCurrentUserDataRequest)

      This is a variant of getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) 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.connect.paginators.GetCurrentUserDataPublisher publisher = client.getCurrentUserDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataPublisher publisher = client.getCurrentUserDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse 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 getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation.

      Parameters:
      getCurrentUserDataRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCurrentUserDataPaginator

      default GetCurrentUserDataPublisher getCurrentUserDataPaginator(Consumer<GetCurrentUserDataRequest.Builder> getCurrentUserDataRequest)

      This is a variant of getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) 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.connect.paginators.GetCurrentUserDataPublisher publisher = client.getCurrentUserDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetCurrentUserDataPublisher publisher = client.getCurrentUserDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetCurrentUserDataResponse 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 getCurrentUserData(software.amazon.awssdk.services.connect.model.GetCurrentUserDataRequest) operation.


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

      Parameters:
      getCurrentUserDataRequest - A Consumer that will call methods on GetCurrentUserDataRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFederationToken

      default CompletableFuture<GetFederationTokenResponse> getFederationToken(GetFederationTokenRequest getFederationTokenRequest)

      Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

      For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

      This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

      Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

      Parameters:
      getFederationTokenRequest -
      Returns:
      A Java Future containing the result of the GetFederationToken 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • UserNotFoundException No user with the specified credentials was found in the Amazon Connect instance.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • DuplicateResourceException A resource with the specified name already exists.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFederationToken

      default CompletableFuture<GetFederationTokenResponse> getFederationToken(Consumer<GetFederationTokenRequest.Builder> getFederationTokenRequest)

      Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.

      For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.

      This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:

      Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect


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

      Parameters:
      getFederationTokenRequest - A Consumer that will call methods on GetFederationTokenRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFederationToken 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • UserNotFoundException No user with the specified credentials was found in the Amazon Connect instance.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • DuplicateResourceException A resource with the specified name already exists.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowAssociation

      default CompletableFuture<GetFlowAssociationResponse> getFlowAssociation(GetFlowAssociationRequest getFlowAssociationRequest)

      Retrieves the flow associated for a given resource.

      Parameters:
      getFlowAssociationRequest -
      Returns:
      A Java Future containing the result of the GetFlowAssociation 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getFlowAssociation

      default CompletableFuture<GetFlowAssociationResponse> getFlowAssociation(Consumer<GetFlowAssociationRequest.Builder> getFlowAssociationRequest)

      Retrieves the flow associated for a given resource.


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

      Parameters:
      getFlowAssociationRequest - A Consumer that will call methods on GetFlowAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetFlowAssociation 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricData

      default CompletableFuture<GetMetricDataResponse> getMetricData(GetMetricDataRequest getMetricDataRequest)

      Gets historical metric data from the specified Amazon Connect instance.

      For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

      Parameters:
      getMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetMetricData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricData

      default CompletableFuture<GetMetricDataResponse> getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)

      Gets historical metric data from the specified Amazon Connect instance.

      For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.


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

      Parameters:
      getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMetricData 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataPaginator

      default GetMetricDataPublisher getMetricDataPaginator(GetMetricDataRequest getMetricDataRequest)

      This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) 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.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataResponse 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 getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.

      Parameters:
      getMetricDataRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataPaginator

      default GetMetricDataPublisher getMetricDataPaginator(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)

      This is a variant of getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) 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.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetMetricDataPublisher publisher = client.getMetricDataPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataResponse 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 getMetricData(software.amazon.awssdk.services.connect.model.GetMetricDataRequest) operation.


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

      Parameters:
      getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataV2

      default CompletableFuture<GetMetricDataV2Response> getMetricDataV2(GetMetricDataV2Request getMetricDataV2Request)

      Gets metric data from the specified Amazon Connect instance.

      GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

      For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.

      Parameters:
      getMetricDataV2Request -
      Returns:
      A Java Future containing the result of the GetMetricDataV2 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataV2

      default CompletableFuture<GetMetricDataV2Response> getMetricDataV2(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request)

      Gets metric data from the specified Amazon Connect instance.

      GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

      For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.


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

      Parameters:
      getMetricDataV2Request - A Consumer that will call methods on GetMetricDataV2Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMetricDataV2 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataV2Paginator

      default GetMetricDataV2Publisher getMetricDataV2Paginator(GetMetricDataV2Request getMetricDataV2Request)

      This is a variant of getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) 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.connect.paginators.GetMetricDataV2Publisher publisher = client.getMetricDataV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Publisher publisher = client.getMetricDataV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataV2Response 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 getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation.

      Parameters:
      getMetricDataV2Request -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricDataV2Paginator

      default GetMetricDataV2Publisher getMetricDataV2Paginator(Consumer<GetMetricDataV2Request.Builder> getMetricDataV2Request)

      This is a variant of getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) 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.connect.paginators.GetMetricDataV2Publisher publisher = client.getMetricDataV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.GetMetricDataV2Publisher publisher = client.getMetricDataV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.GetMetricDataV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.GetMetricDataV2Response 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 getMetricDataV2(software.amazon.awssdk.services.connect.model.GetMetricDataV2Request) operation.


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

      Parameters:
      getMetricDataV2Request - A Consumer that will call methods on GetMetricDataV2Request.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPromptFile

      default CompletableFuture<GetPromptFileResponse> getPromptFile(GetPromptFileRequest getPromptFileRequest)

      Gets the prompt file.

      Parameters:
      getPromptFileRequest -
      Returns:
      A Java Future containing the result of the GetPromptFile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InvalidRequestException The request is not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPromptFile

      default CompletableFuture<GetPromptFileResponse> getPromptFile(Consumer<GetPromptFileRequest.Builder> getPromptFileRequest)

      Gets the prompt file.


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

      Parameters:
      getPromptFileRequest - A Consumer that will call methods on GetPromptFileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPromptFile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InvalidRequestException The request is not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTaskTemplate

      default CompletableFuture<GetTaskTemplateResponse> getTaskTemplate(GetTaskTemplateRequest getTaskTemplateRequest)

      Gets details about a specific task template in the specified Amazon Connect instance.

      Parameters:
      getTaskTemplateRequest -
      Returns:
      A Java Future containing the result of the GetTaskTemplate 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTaskTemplate

      default CompletableFuture<GetTaskTemplateResponse> getTaskTemplate(Consumer<GetTaskTemplateRequest.Builder> getTaskTemplateRequest)

      Gets details about a specific task template in the specified Amazon Connect instance.


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

      Parameters:
      getTaskTemplateRequest - A Consumer that will call methods on GetTaskTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTaskTemplate 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTrafficDistribution

      default CompletableFuture<GetTrafficDistributionResponse> getTrafficDistribution(GetTrafficDistributionRequest getTrafficDistributionRequest)

      Retrieves the current traffic distribution for a given traffic distribution group.

      Parameters:
      getTrafficDistributionRequest -
      Returns:
      A Java Future containing the result of the GetTrafficDistribution 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTrafficDistribution

      default CompletableFuture<GetTrafficDistributionResponse> getTrafficDistribution(Consumer<GetTrafficDistributionRequest.Builder> getTrafficDistributionRequest)

      Retrieves the current traffic distribution for a given traffic distribution group.


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

      Parameters:
      getTrafficDistributionRequest - A Consumer that will call methods on GetTrafficDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTrafficDistribution 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importPhoneNumber

      default CompletableFuture<ImportPhoneNumberResponse> importPhoneNumber(ImportPhoneNumberRequest importPhoneNumberRequest)

      Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

      Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

      If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

      Parameters:
      importPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the ImportPhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importPhoneNumber

      default CompletableFuture<ImportPhoneNumberResponse> importPhoneNumber(Consumer<ImportPhoneNumberRequest.Builder> importPhoneNumberRequest)

      Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.

      Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.

      If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.


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

      Parameters:
      importPhoneNumberRequest - A Consumer that will call methods on ImportPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportPhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentStatuses

      default CompletableFuture<ListAgentStatusesResponse> listAgentStatuses(ListAgentStatusesRequest listAgentStatusesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Lists agent statuses.

      Parameters:
      listAgentStatusesRequest -
      Returns:
      A Java Future containing the result of the ListAgentStatuses 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentStatuses

      default CompletableFuture<ListAgentStatusesResponse> listAgentStatuses(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Lists agent statuses.


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

      Parameters:
      listAgentStatusesRequest - A Consumer that will call methods on ListAgentStatusesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgentStatuses 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentStatusesPaginator

      default ListAgentStatusesPublisher listAgentStatusesPaginator(ListAgentStatusesRequest listAgentStatusesRequest)

      This is a variant of listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) 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.connect.paginators.ListAgentStatusesPublisher publisher = client.listAgentStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesPublisher publisher = client.listAgentStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse 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 listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation.

      Parameters:
      listAgentStatusesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentStatusesPaginator

      default ListAgentStatusesPublisher listAgentStatusesPaginator(Consumer<ListAgentStatusesRequest.Builder> listAgentStatusesRequest)

      This is a variant of listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) 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.connect.paginators.ListAgentStatusesPublisher publisher = client.listAgentStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListAgentStatusesPublisher publisher = client.listAgentStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListAgentStatusesResponse 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 listAgentStatuses(software.amazon.awssdk.services.connect.model.ListAgentStatusesRequest) operation.


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

      Parameters:
      listAgentStatusesRequest - A Consumer that will call methods on ListAgentStatusesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAnalyticsDataAssociations

      default CompletableFuture<ListAnalyticsDataAssociationsResponse> listAnalyticsDataAssociations(ListAnalyticsDataAssociationsRequest listAnalyticsDataAssociationsRequest)

      Lists the association status of requested dataset ID for a given Amazon Connect instance.

      Parameters:
      listAnalyticsDataAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListAnalyticsDataAssociations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAnalyticsDataAssociations

      default CompletableFuture<ListAnalyticsDataAssociationsResponse> listAnalyticsDataAssociations(Consumer<ListAnalyticsDataAssociationsRequest.Builder> listAnalyticsDataAssociationsRequest)

      Lists the association status of requested dataset ID for a given Amazon Connect instance.


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

      Parameters:
      listAnalyticsDataAssociationsRequest - A Consumer that will call methods on ListAnalyticsDataAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAnalyticsDataAssociations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApprovedOrigins

      default CompletableFuture<ListApprovedOriginsResponse> listApprovedOrigins(ListApprovedOriginsRequest listApprovedOriginsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all approved origins associated with the instance.

      Parameters:
      listApprovedOriginsRequest -
      Returns:
      A Java Future containing the result of the ListApprovedOrigins 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApprovedOrigins

      default CompletableFuture<ListApprovedOriginsResponse> listApprovedOrigins(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all approved origins associated with the instance.


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

      Parameters:
      listApprovedOriginsRequest - A Consumer that will call methods on ListApprovedOriginsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListApprovedOrigins 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApprovedOriginsPaginator

      default ListApprovedOriginsPublisher listApprovedOriginsPaginator(ListApprovedOriginsRequest listApprovedOriginsRequest)

      This is a variant of listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) 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.connect.paginators.ListApprovedOriginsPublisher publisher = client.listApprovedOriginsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsPublisher publisher = client.listApprovedOriginsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse 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 listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation.

      Parameters:
      listApprovedOriginsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listApprovedOriginsPaginator

      default ListApprovedOriginsPublisher listApprovedOriginsPaginator(Consumer<ListApprovedOriginsRequest.Builder> listApprovedOriginsRequest)

      This is a variant of listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) 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.connect.paginators.ListApprovedOriginsPublisher publisher = client.listApprovedOriginsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListApprovedOriginsPublisher publisher = client.listApprovedOriginsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListApprovedOriginsResponse 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 listApprovedOrigins(software.amazon.awssdk.services.connect.model.ListApprovedOriginsRequest) operation.


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

      Parameters:
      listApprovedOriginsRequest - A Consumer that will call methods on ListApprovedOriginsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAuthenticationProfiles

      default CompletableFuture<ListAuthenticationProfilesResponse> listAuthenticationProfiles(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Provides summary information about the authentication profiles in a specified Amazon Connect instance.

      Parameters:
      listAuthenticationProfilesRequest -
      Returns:
      A Java Future containing the result of the ListAuthenticationProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAuthenticationProfiles

      default CompletableFuture<ListAuthenticationProfilesResponse> listAuthenticationProfiles(Consumer<ListAuthenticationProfilesRequest.Builder> listAuthenticationProfilesRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Provides summary information about the authentication profiles in a specified Amazon Connect instance.


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

      Parameters:
      listAuthenticationProfilesRequest - A Consumer that will call methods on ListAuthenticationProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAuthenticationProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAuthenticationProfilesPaginator

      default ListAuthenticationProfilesPublisher listAuthenticationProfilesPaginator(ListAuthenticationProfilesRequest listAuthenticationProfilesRequest)

      This is a variant of listAuthenticationProfiles(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesRequest) 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.connect.paginators.ListAuthenticationProfilesPublisher publisher = client.listAuthenticationProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListAuthenticationProfilesPublisher publisher = client.listAuthenticationProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesResponse 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 listAuthenticationProfiles(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesRequest) operation.

      Parameters:
      listAuthenticationProfilesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAuthenticationProfilesPaginator

      default ListAuthenticationProfilesPublisher listAuthenticationProfilesPaginator(Consumer<ListAuthenticationProfilesRequest.Builder> listAuthenticationProfilesRequest)

      This is a variant of listAuthenticationProfiles(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesRequest) 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.connect.paginators.ListAuthenticationProfilesPublisher publisher = client.listAuthenticationProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListAuthenticationProfilesPublisher publisher = client.listAuthenticationProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesResponse 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 listAuthenticationProfiles(software.amazon.awssdk.services.connect.model.ListAuthenticationProfilesRequest) operation.


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

      Parameters:
      listAuthenticationProfilesRequest - A Consumer that will call methods on ListAuthenticationProfilesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBots

      default CompletableFuture<ListBotsResponse> listBots(ListBotsRequest listBotsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.

      Parameters:
      listBotsRequest -
      Returns:
      A Java Future containing the result of the ListBots 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBots

      default CompletableFuture<ListBotsResponse> listBots(Consumer<ListBotsRequest.Builder> listBotsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.


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

      Parameters:
      listBotsRequest - A Consumer that will call methods on ListBotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListBots 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBotsPaginator

      default ListBotsPublisher listBotsPaginator(ListBotsRequest listBotsRequest)

      This is a variant of listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) 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.connect.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListBotsResponse 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 listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation.

      Parameters:
      listBotsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listBotsPaginator

      default ListBotsPublisher listBotsPaginator(Consumer<ListBotsRequest.Builder> listBotsRequest)

      This is a variant of listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) 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.connect.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListBotsPublisher publisher = client.listBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListBotsResponse 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 listBots(software.amazon.awssdk.services.connect.model.ListBotsRequest) operation.


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

      Parameters:
      listBotsRequest - A Consumer that will call methods on ListBotsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactEvaluations

      default CompletableFuture<ListContactEvaluationsResponse> listContactEvaluations(ListContactEvaluationsRequest listContactEvaluationsRequest)

      Lists contact evaluations in the specified Amazon Connect instance.

      Parameters:
      listContactEvaluationsRequest -
      Returns:
      A Java Future containing the result of the ListContactEvaluations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactEvaluations

      default CompletableFuture<ListContactEvaluationsResponse> listContactEvaluations(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest)

      Lists contact evaluations in the specified Amazon Connect instance.


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

      Parameters:
      listContactEvaluationsRequest - A Consumer that will call methods on ListContactEvaluationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContactEvaluations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactEvaluationsPaginator

      default ListContactEvaluationsPublisher listContactEvaluationsPaginator(ListContactEvaluationsRequest listContactEvaluationsRequest)

      This is a variant of listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) 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.connect.paginators.ListContactEvaluationsPublisher publisher = client.listContactEvaluationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsPublisher publisher = client.listContactEvaluationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse 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 null 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 listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation.

      Parameters:
      listContactEvaluationsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactEvaluationsPaginator

      default ListContactEvaluationsPublisher listContactEvaluationsPaginator(Consumer<ListContactEvaluationsRequest.Builder> listContactEvaluationsRequest)

      This is a variant of listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) 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.connect.paginators.ListContactEvaluationsPublisher publisher = client.listContactEvaluationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactEvaluationsPublisher publisher = client.listContactEvaluationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactEvaluationsResponse 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 null 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 listContactEvaluations(software.amazon.awssdk.services.connect.model.ListContactEvaluationsRequest) operation.


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

      Parameters:
      listContactEvaluationsRequest - A Consumer that will call methods on ListContactEvaluationsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowModules

      default CompletableFuture<ListContactFlowModulesResponse> listContactFlowModules(ListContactFlowModulesRequest listContactFlowModulesRequest)

      Provides information about the flow modules for the specified Amazon Connect instance.

      Parameters:
      listContactFlowModulesRequest -
      Returns:
      A Java Future containing the result of the ListContactFlowModules 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowModules

      default CompletableFuture<ListContactFlowModulesResponse> listContactFlowModules(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest)

      Provides information about the flow modules for the specified Amazon Connect instance.


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

      Parameters:
      listContactFlowModulesRequest - A Consumer that will call methods on ListContactFlowModulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContactFlowModules 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowModulesPaginator

      default ListContactFlowModulesPublisher listContactFlowModulesPaginator(ListContactFlowModulesRequest listContactFlowModulesRequest)

      This is a variant of listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) 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.connect.paginators.ListContactFlowModulesPublisher publisher = client.listContactFlowModulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesPublisher publisher = client.listContactFlowModulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse 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 listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation.

      Parameters:
      listContactFlowModulesRequest -
      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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowModulesPaginator

      default ListContactFlowModulesPublisher listContactFlowModulesPaginator(Consumer<ListContactFlowModulesRequest.Builder> listContactFlowModulesRequest)

      This is a variant of listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) 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.connect.paginators.ListContactFlowModulesPublisher publisher = client.listContactFlowModulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactFlowModulesPublisher publisher = client.listContactFlowModulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactFlowModulesResponse 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 listContactFlowModules(software.amazon.awssdk.services.connect.model.ListContactFlowModulesRequest) operation.


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

      Parameters:
      listContactFlowModulesRequest - A Consumer that will call methods on ListContactFlowModulesRequest.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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlows

      default CompletableFuture<ListContactFlowsResponse> listContactFlows(ListContactFlowsRequest listContactFlowsRequest)

      Provides information about the flows for the specified Amazon Connect instance.

      You can also create and update flows using the Amazon Connect Flow language.

      For more information about flows, see Flows in the Amazon Connect Administrator Guide.

      Parameters:
      listContactFlowsRequest -
      Returns:
      A Java Future containing the result of the ListContactFlows 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlows

      default CompletableFuture<ListContactFlowsResponse> listContactFlows(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest)

      Provides information about the flows for the specified Amazon Connect instance.

      You can also create and update flows using the Amazon Connect Flow language.

      For more information about flows, see Flows in the Amazon Connect Administrator Guide.


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

      Parameters:
      listContactFlowsRequest - A Consumer that will call methods on ListContactFlowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContactFlows 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowsPaginator

      default ListContactFlowsPublisher listContactFlowsPaginator(ListContactFlowsRequest listContactFlowsRequest)

      This is a variant of listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) 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.connect.paginators.ListContactFlowsPublisher publisher = client.listContactFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsPublisher publisher = client.listContactFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactFlowsResponse 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 listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation.

      Parameters:
      listContactFlowsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactFlowsPaginator

      default ListContactFlowsPublisher listContactFlowsPaginator(Consumer<ListContactFlowsRequest.Builder> listContactFlowsRequest)

      This is a variant of listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) 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.connect.paginators.ListContactFlowsPublisher publisher = client.listContactFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactFlowsPublisher publisher = client.listContactFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactFlowsResponse 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 listContactFlows(software.amazon.awssdk.services.connect.model.ListContactFlowsRequest) operation.


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

      Parameters:
      listContactFlowsRequest - A Consumer that will call methods on ListContactFlowsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactReferences

      default CompletableFuture<ListContactReferencesResponse> listContactReferences(ListContactReferencesRequest listContactReferencesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

      Parameters:
      listContactReferencesRequest -
      Returns:
      A Java Future containing the result of the ListContactReferences 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactReferences

      default CompletableFuture<ListContactReferencesResponse> listContactReferences(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.


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

      Parameters:
      listContactReferencesRequest - A Consumer that will call methods on ListContactReferencesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContactReferences 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactReferencesPaginator

      default ListContactReferencesPublisher listContactReferencesPaginator(ListContactReferencesRequest listContactReferencesRequest)

      This is a variant of listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) 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.connect.paginators.ListContactReferencesPublisher publisher = client.listContactReferencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesPublisher publisher = client.listContactReferencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactReferencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactReferencesResponse 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 null 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 listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation.

      Parameters:
      listContactReferencesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContactReferencesPaginator

      default ListContactReferencesPublisher listContactReferencesPaginator(Consumer<ListContactReferencesRequest.Builder> listContactReferencesRequest)

      This is a variant of listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) 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.connect.paginators.ListContactReferencesPublisher publisher = client.listContactReferencesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListContactReferencesPublisher publisher = client.listContactReferencesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListContactReferencesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListContactReferencesResponse 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 null 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 listContactReferences(software.amazon.awssdk.services.connect.model.ListContactReferencesRequest) operation.


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

      Parameters:
      listContactReferencesRequest - A Consumer that will call methods on ListContactReferencesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDefaultVocabularies

      default CompletableFuture<ListDefaultVocabulariesResponse> listDefaultVocabularies(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)

      Lists the default vocabularies for the specified Amazon Connect instance.

      Parameters:
      listDefaultVocabulariesRequest -
      Returns:
      A Java Future containing the result of the ListDefaultVocabularies 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDefaultVocabularies

      default CompletableFuture<ListDefaultVocabulariesResponse> listDefaultVocabularies(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest)

      Lists the default vocabularies for the specified Amazon Connect instance.


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

      Parameters:
      listDefaultVocabulariesRequest - A Consumer that will call methods on ListDefaultVocabulariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDefaultVocabularies 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDefaultVocabulariesPaginator

      default ListDefaultVocabulariesPublisher listDefaultVocabulariesPaginator(ListDefaultVocabulariesRequest listDefaultVocabulariesRequest)

      This is a variant of listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) 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.connect.paginators.ListDefaultVocabulariesPublisher publisher = client.listDefaultVocabulariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesPublisher publisher = client.listDefaultVocabulariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse 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 listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation.

      Parameters:
      listDefaultVocabulariesRequest -
      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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDefaultVocabulariesPaginator

      default ListDefaultVocabulariesPublisher listDefaultVocabulariesPaginator(Consumer<ListDefaultVocabulariesRequest.Builder> listDefaultVocabulariesRequest)

      This is a variant of listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) 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.connect.paginators.ListDefaultVocabulariesPublisher publisher = client.listDefaultVocabulariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListDefaultVocabulariesPublisher publisher = client.listDefaultVocabulariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesResponse 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 listDefaultVocabularies(software.amazon.awssdk.services.connect.model.ListDefaultVocabulariesRequest) operation.


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

      Parameters:
      listDefaultVocabulariesRequest - A Consumer that will call methods on ListDefaultVocabulariesRequest.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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormVersions

      default CompletableFuture<ListEvaluationFormVersionsResponse> listEvaluationFormVersions(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)

      Lists versions of an evaluation form in the specified Amazon Connect instance.

      Parameters:
      listEvaluationFormVersionsRequest -
      Returns:
      A Java Future containing the result of the ListEvaluationFormVersions 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormVersions

      default CompletableFuture<ListEvaluationFormVersionsResponse> listEvaluationFormVersions(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest)

      Lists versions of an evaluation form in the specified Amazon Connect instance.


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

      Parameters:
      listEvaluationFormVersionsRequest - A Consumer that will call methods on ListEvaluationFormVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEvaluationFormVersions 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormVersionsPaginator

      default ListEvaluationFormVersionsPublisher listEvaluationFormVersionsPaginator(ListEvaluationFormVersionsRequest listEvaluationFormVersionsRequest)

      This is a variant of listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) 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.connect.paginators.ListEvaluationFormVersionsPublisher publisher = client.listEvaluationFormVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsPublisher publisher = client.listEvaluationFormVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse 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 listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation.

      Parameters:
      listEvaluationFormVersionsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormVersionsPaginator

      default ListEvaluationFormVersionsPublisher listEvaluationFormVersionsPaginator(Consumer<ListEvaluationFormVersionsRequest.Builder> listEvaluationFormVersionsRequest)

      This is a variant of listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) 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.connect.paginators.ListEvaluationFormVersionsPublisher publisher = client.listEvaluationFormVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormVersionsPublisher publisher = client.listEvaluationFormVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsResponse 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 listEvaluationFormVersions(software.amazon.awssdk.services.connect.model.ListEvaluationFormVersionsRequest) operation.


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

      Parameters:
      listEvaluationFormVersionsRequest - A Consumer that will call methods on ListEvaluationFormVersionsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationForms

      default CompletableFuture<ListEvaluationFormsResponse> listEvaluationForms(ListEvaluationFormsRequest listEvaluationFormsRequest)

      Lists evaluation forms in the specified Amazon Connect instance.

      Parameters:
      listEvaluationFormsRequest -
      Returns:
      A Java Future containing the result of the ListEvaluationForms 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationForms

      default CompletableFuture<ListEvaluationFormsResponse> listEvaluationForms(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest)

      Lists evaluation forms in the specified Amazon Connect instance.


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

      Parameters:
      listEvaluationFormsRequest - A Consumer that will call methods on ListEvaluationFormsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListEvaluationForms 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormsPaginator

      default ListEvaluationFormsPublisher listEvaluationFormsPaginator(ListEvaluationFormsRequest listEvaluationFormsRequest)

      This is a variant of listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) 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.connect.paginators.ListEvaluationFormsPublisher publisher = client.listEvaluationFormsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsPublisher publisher = client.listEvaluationFormsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse 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 listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation.

      Parameters:
      listEvaluationFormsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listEvaluationFormsPaginator

      default ListEvaluationFormsPublisher listEvaluationFormsPaginator(Consumer<ListEvaluationFormsRequest.Builder> listEvaluationFormsRequest)

      This is a variant of listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) 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.connect.paginators.ListEvaluationFormsPublisher publisher = client.listEvaluationFormsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListEvaluationFormsPublisher publisher = client.listEvaluationFormsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListEvaluationFormsResponse 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 listEvaluationForms(software.amazon.awssdk.services.connect.model.ListEvaluationFormsRequest) operation.


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

      Parameters:
      listEvaluationFormsRequest - A Consumer that will call methods on ListEvaluationFormsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowAssociations

      default CompletableFuture<ListFlowAssociationsResponse> listFlowAssociations(ListFlowAssociationsRequest listFlowAssociationsRequest)

      List the flow association based on the filters.

      Parameters:
      listFlowAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListFlowAssociations 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowAssociations

      default CompletableFuture<ListFlowAssociationsResponse> listFlowAssociations(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest)

      List the flow association based on the filters.


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

      Parameters:
      listFlowAssociationsRequest - A Consumer that will call methods on ListFlowAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlowAssociations 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowAssociationsPaginator

      default ListFlowAssociationsPublisher listFlowAssociationsPaginator(ListFlowAssociationsRequest listFlowAssociationsRequest)

      This is a variant of listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest) 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.connect.paginators.ListFlowAssociationsPublisher publisher = client.listFlowAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListFlowAssociationsPublisher publisher = client.listFlowAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse 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 listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest) operation.

      Parameters:
      listFlowAssociationsRequest -
      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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowAssociationsPaginator

      default ListFlowAssociationsPublisher listFlowAssociationsPaginator(Consumer<ListFlowAssociationsRequest.Builder> listFlowAssociationsRequest)

      This is a variant of listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest) 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.connect.paginators.ListFlowAssociationsPublisher publisher = client.listFlowAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListFlowAssociationsPublisher publisher = client.listFlowAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListFlowAssociationsResponse 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 listFlowAssociations(software.amazon.awssdk.services.connect.model.ListFlowAssociationsRequest) operation.


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

      Parameters:
      listFlowAssociationsRequest - A Consumer that will call methods on ListFlowAssociationsRequest.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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHoursOfOperations

      default CompletableFuture<ListHoursOfOperationsResponse> listHoursOfOperations(ListHoursOfOperationsRequest listHoursOfOperationsRequest)

      Provides information about the hours of operation for the specified Amazon Connect instance.

      For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

      Parameters:
      listHoursOfOperationsRequest -
      Returns:
      A Java Future containing the result of the ListHoursOfOperations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHoursOfOperations

      default CompletableFuture<ListHoursOfOperationsResponse> listHoursOfOperations(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest)

      Provides information about the hours of operation for the specified Amazon Connect instance.

      For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.


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

      Parameters:
      listHoursOfOperationsRequest - A Consumer that will call methods on ListHoursOfOperationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListHoursOfOperations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHoursOfOperationsPaginator

      default ListHoursOfOperationsPublisher listHoursOfOperationsPaginator(ListHoursOfOperationsRequest listHoursOfOperationsRequest)

      This is a variant of listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) 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.connect.paginators.ListHoursOfOperationsPublisher publisher = client.listHoursOfOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsPublisher publisher = client.listHoursOfOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse 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 listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation.

      Parameters:
      listHoursOfOperationsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHoursOfOperationsPaginator

      default ListHoursOfOperationsPublisher listHoursOfOperationsPaginator(Consumer<ListHoursOfOperationsRequest.Builder> listHoursOfOperationsRequest)

      This is a variant of listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) 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.connect.paginators.ListHoursOfOperationsPublisher publisher = client.listHoursOfOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListHoursOfOperationsPublisher publisher = client.listHoursOfOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsResponse 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 listHoursOfOperations(software.amazon.awssdk.services.connect.model.ListHoursOfOperationsRequest) operation.


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

      Parameters:
      listHoursOfOperationsRequest - A Consumer that will call methods on ListHoursOfOperationsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceAttributes

      default CompletableFuture<ListInstanceAttributesResponse> listInstanceAttributes(ListInstanceAttributesRequest listInstanceAttributesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all attribute types for the given instance.

      Parameters:
      listInstanceAttributesRequest -
      Returns:
      A Java Future containing the result of the ListInstanceAttributes 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceAttributes

      default CompletableFuture<ListInstanceAttributesResponse> listInstanceAttributes(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all attribute types for the given instance.


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

      Parameters:
      listInstanceAttributesRequest - A Consumer that will call methods on ListInstanceAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInstanceAttributes 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceAttributesPaginator

      default ListInstanceAttributesPublisher listInstanceAttributesPaginator(ListInstanceAttributesRequest listInstanceAttributesRequest)

      This is a variant of listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) 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.connect.paginators.ListInstanceAttributesPublisher publisher = client.listInstanceAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesPublisher publisher = client.listInstanceAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse 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 listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation.

      Parameters:
      listInstanceAttributesRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceAttributesPaginator

      default ListInstanceAttributesPublisher listInstanceAttributesPaginator(Consumer<ListInstanceAttributesRequest.Builder> listInstanceAttributesRequest)

      This is a variant of listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) 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.connect.paginators.ListInstanceAttributesPublisher publisher = client.listInstanceAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstanceAttributesPublisher publisher = client.listInstanceAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstanceAttributesResponse 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 listInstanceAttributes(software.amazon.awssdk.services.connect.model.ListInstanceAttributesRequest) operation.


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

      Parameters:
      listInstanceAttributesRequest - A Consumer that will call methods on ListInstanceAttributesRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceStorageConfigs

      default CompletableFuture<ListInstanceStorageConfigsResponse> listInstanceStorageConfigs(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of storage configs for the identified instance and resource type.

      Parameters:
      listInstanceStorageConfigsRequest -
      Returns:
      A Java Future containing the result of the ListInstanceStorageConfigs 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceStorageConfigs

      default CompletableFuture<ListInstanceStorageConfigsResponse> listInstanceStorageConfigs(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of storage configs for the identified instance and resource type.


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

      Parameters:
      listInstanceStorageConfigsRequest - A Consumer that will call methods on ListInstanceStorageConfigsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInstanceStorageConfigs 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceStorageConfigsPaginator

      default ListInstanceStorageConfigsPublisher listInstanceStorageConfigsPaginator(ListInstanceStorageConfigsRequest listInstanceStorageConfigsRequest)

      This is a variant of listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) 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.connect.paginators.ListInstanceStorageConfigsPublisher publisher = client.listInstanceStorageConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsPublisher publisher = client.listInstanceStorageConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse 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 listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation.

      Parameters:
      listInstanceStorageConfigsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstanceStorageConfigsPaginator

      default ListInstanceStorageConfigsPublisher listInstanceStorageConfigsPaginator(Consumer<ListInstanceStorageConfigsRequest.Builder> listInstanceStorageConfigsRequest)

      This is a variant of listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) 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.connect.paginators.ListInstanceStorageConfigsPublisher publisher = client.listInstanceStorageConfigsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstanceStorageConfigsPublisher publisher = client.listInstanceStorageConfigsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsResponse 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 listInstanceStorageConfigs(software.amazon.awssdk.services.connect.model.ListInstanceStorageConfigsRequest) operation.


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

      Parameters:
      listInstanceStorageConfigsRequest - A Consumer that will call methods on ListInstanceStorageConfigsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstances

      default CompletableFuture<ListInstancesResponse> listInstances(ListInstancesRequest listInstancesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

      Parameters:
      listInstancesRequest -
      Returns:
      A Java Future containing the result of the ListInstances 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstances

      default CompletableFuture<ListInstancesResponse> listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.


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

      Parameters:
      listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListInstances 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstancesPaginator

      default ListInstancesPublisher listInstancesPaginator(ListInstancesRequest listInstancesRequest)

      This is a variant of listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) 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.connect.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstancesResponse 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 listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation.

      Parameters:
      listInstancesRequest -
      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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listInstancesPaginator

      default ListInstancesPublisher listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)

      This is a variant of listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) 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.connect.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListInstancesPublisher publisher = client.listInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListInstancesResponse 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 listInstances(software.amazon.awssdk.services.connect.model.ListInstancesRequest) operation.


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

      Parameters:
      listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIntegrationAssociations

      default CompletableFuture<ListIntegrationAssociationsResponse> listIntegrationAssociations(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)

      Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

      Parameters:
      listIntegrationAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListIntegrationAssociations 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIntegrationAssociations

      default CompletableFuture<ListIntegrationAssociationsResponse> listIntegrationAssociations(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest)

      Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.


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

      Parameters:
      listIntegrationAssociationsRequest - A Consumer that will call methods on ListIntegrationAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIntegrationAssociations 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIntegrationAssociationsPaginator

      default ListIntegrationAssociationsPublisher listIntegrationAssociationsPaginator(ListIntegrationAssociationsRequest listIntegrationAssociationsRequest)

      This is a variant of listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) 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.connect.paginators.ListIntegrationAssociationsPublisher publisher = client.listIntegrationAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsPublisher publisher = client.listIntegrationAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse 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 listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation.

      Parameters:
      listIntegrationAssociationsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIntegrationAssociationsPaginator

      default ListIntegrationAssociationsPublisher listIntegrationAssociationsPaginator(Consumer<ListIntegrationAssociationsRequest.Builder> listIntegrationAssociationsRequest)

      This is a variant of listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) 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.connect.paginators.ListIntegrationAssociationsPublisher publisher = client.listIntegrationAssociationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListIntegrationAssociationsPublisher publisher = client.listIntegrationAssociationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsResponse 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 listIntegrationAssociations(software.amazon.awssdk.services.connect.model.ListIntegrationAssociationsRequest) operation.


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

      Parameters:
      listIntegrationAssociationsRequest - A Consumer that will call methods on ListIntegrationAssociationsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLambdaFunctions

      default CompletableFuture<ListLambdaFunctionsResponse> listLambdaFunctions(ListLambdaFunctionsRequest listLambdaFunctionsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

      Parameters:
      listLambdaFunctionsRequest -
      Returns:
      A Java Future containing the result of the ListLambdaFunctions 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLambdaFunctions

      default CompletableFuture<ListLambdaFunctionsResponse> listLambdaFunctions(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.


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

      Parameters:
      listLambdaFunctionsRequest - A Consumer that will call methods on ListLambdaFunctionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLambdaFunctions 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLambdaFunctionsPaginator

      default ListLambdaFunctionsPublisher listLambdaFunctionsPaginator(ListLambdaFunctionsRequest listLambdaFunctionsRequest)

      This is a variant of listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) 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.connect.paginators.ListLambdaFunctionsPublisher publisher = client.listLambdaFunctionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsPublisher publisher = client.listLambdaFunctionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse 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 listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation.

      Parameters:
      listLambdaFunctionsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLambdaFunctionsPaginator

      default ListLambdaFunctionsPublisher listLambdaFunctionsPaginator(Consumer<ListLambdaFunctionsRequest.Builder> listLambdaFunctionsRequest)

      This is a variant of listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) 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.connect.paginators.ListLambdaFunctionsPublisher publisher = client.listLambdaFunctionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListLambdaFunctionsPublisher publisher = client.listLambdaFunctionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsResponse 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 listLambdaFunctions(software.amazon.awssdk.services.connect.model.ListLambdaFunctionsRequest) operation.


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

      Parameters:
      listLambdaFunctionsRequest - A Consumer that will call methods on ListLambdaFunctionsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLexBots

      default CompletableFuture<ListLexBotsResponse> listLexBots(ListLexBotsRequest listLexBotsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.

      Parameters:
      listLexBotsRequest -
      Returns:
      A Java Future containing the result of the ListLexBots 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLexBots

      default CompletableFuture<ListLexBotsResponse> listLexBots(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.


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

      Parameters:
      listLexBotsRequest - A Consumer that will call methods on ListLexBotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLexBots 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLexBotsPaginator

      default ListLexBotsPublisher listLexBotsPaginator(ListLexBotsRequest listLexBotsRequest)

      This is a variant of listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) 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.connect.paginators.ListLexBotsPublisher publisher = client.listLexBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListLexBotsPublisher publisher = client.listLexBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListLexBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListLexBotsResponse 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 listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation.

      Parameters:
      listLexBotsRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLexBotsPaginator

      default ListLexBotsPublisher listLexBotsPaginator(Consumer<ListLexBotsRequest.Builder> listLexBotsRequest)

      This is a variant of listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) 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.connect.paginators.ListLexBotsPublisher publisher = client.listLexBotsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListLexBotsPublisher publisher = client.listLexBotsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListLexBotsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListLexBotsResponse 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 listLexBots(software.amazon.awssdk.services.connect.model.ListLexBotsRequest) operation.


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

      Parameters:
      listLexBotsRequest - A Consumer that will call methods on ListLexBotsRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbers

      default CompletableFuture<ListPhoneNumbersResponse> listPhoneNumbers(ListPhoneNumbersRequest listPhoneNumbersRequest)

      Provides information about the phone numbers for the specified Amazon Connect instance.

      For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

      • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

      • The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.

      Parameters:
      listPhoneNumbersRequest -
      Returns:
      A Java Future containing the result of the ListPhoneNumbers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbers

      default CompletableFuture<ListPhoneNumbersResponse> listPhoneNumbers(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)

      Provides information about the phone numbers for the specified Amazon Connect instance.

      For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

      • We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.

      • The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.


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

      Parameters:
      listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPhoneNumbers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersPaginator

      default ListPhoneNumbersPublisher listPhoneNumbersPaginator(ListPhoneNumbersRequest listPhoneNumbersRequest)

      This is a variant of listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) 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.connect.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse 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 listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation.

      Parameters:
      listPhoneNumbersRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersPaginator

      default ListPhoneNumbersPublisher listPhoneNumbersPaginator(Consumer<ListPhoneNumbersRequest.Builder> listPhoneNumbersRequest)

      This is a variant of listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) 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.connect.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersPublisher publisher = client.listPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPhoneNumbersResponse 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 listPhoneNumbers(software.amazon.awssdk.services.connect.model.ListPhoneNumbersRequest) operation.


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

      Parameters:
      listPhoneNumbersRequest - A Consumer that will call methods on ListPhoneNumbersRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersV2

      default CompletableFuture<ListPhoneNumbersV2Response> listPhoneNumbersV2(ListPhoneNumbersV2Request listPhoneNumbersV2Request)

      Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

      For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

      • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

      • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.

      Parameters:
      listPhoneNumbersV2Request -
      Returns:
      A Java Future containing the result of the ListPhoneNumbersV2 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersV2

      default CompletableFuture<ListPhoneNumbersV2Response> listPhoneNumbersV2(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request)

      Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group.

      For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

      • When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.

      • When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.


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

      Parameters:
      listPhoneNumbersV2Request - A Consumer that will call methods on ListPhoneNumbersV2Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPhoneNumbersV2 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersV2Paginator

      default ListPhoneNumbersV2Publisher listPhoneNumbersV2Paginator(ListPhoneNumbersV2Request listPhoneNumbersV2Request)

      This is a variant of listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) 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.connect.paginators.ListPhoneNumbersV2Publisher publisher = client.listPhoneNumbersV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Publisher publisher = client.listPhoneNumbersV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response 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 listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation.

      Parameters:
      listPhoneNumbersV2Request -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPhoneNumbersV2Paginator

      default ListPhoneNumbersV2Publisher listPhoneNumbersV2Paginator(Consumer<ListPhoneNumbersV2Request.Builder> listPhoneNumbersV2Request)

      This is a variant of listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) 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.connect.paginators.ListPhoneNumbersV2Publisher publisher = client.listPhoneNumbersV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPhoneNumbersV2Publisher publisher = client.listPhoneNumbersV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Response 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 listPhoneNumbersV2(software.amazon.awssdk.services.connect.model.ListPhoneNumbersV2Request) operation.


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

      Parameters:
      listPhoneNumbersV2Request - A Consumer that will call methods on ListPhoneNumbersV2Request.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPredefinedAttributes

      default CompletableFuture<ListPredefinedAttributesResponse> listPredefinedAttributes(ListPredefinedAttributesRequest listPredefinedAttributesRequest)

      Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

      Parameters:
      listPredefinedAttributesRequest -
      Returns:
      A Java Future containing the result of the ListPredefinedAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPredefinedAttributes

      default CompletableFuture<ListPredefinedAttributesResponse> listPredefinedAttributes(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest)

      Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.


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

      Parameters:
      listPredefinedAttributesRequest - A Consumer that will call methods on ListPredefinedAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPredefinedAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPredefinedAttributesPaginator

      default ListPredefinedAttributesPublisher listPredefinedAttributesPaginator(ListPredefinedAttributesRequest listPredefinedAttributesRequest)

      This is a variant of listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest) 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.connect.paginators.ListPredefinedAttributesPublisher publisher = client.listPredefinedAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesPublisher publisher = client.listPredefinedAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse 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 listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest) operation.

      Parameters:
      listPredefinedAttributesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPredefinedAttributesPaginator

      default ListPredefinedAttributesPublisher listPredefinedAttributesPaginator(Consumer<ListPredefinedAttributesRequest.Builder> listPredefinedAttributesRequest)

      This is a variant of listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest) 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.connect.paginators.ListPredefinedAttributesPublisher publisher = client.listPredefinedAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPredefinedAttributesPublisher publisher = client.listPredefinedAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesResponse 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 listPredefinedAttributes(software.amazon.awssdk.services.connect.model.ListPredefinedAttributesRequest) operation.


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

      Parameters:
      listPredefinedAttributesRequest - A Consumer that will call methods on ListPredefinedAttributesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPrompts

      default CompletableFuture<ListPromptsResponse> listPrompts(ListPromptsRequest listPromptsRequest)

      Provides information about the prompts for the specified Amazon Connect instance.

      Parameters:
      listPromptsRequest -
      Returns:
      A Java Future containing the result of the ListPrompts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPrompts

      default CompletableFuture<ListPromptsResponse> listPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest)

      Provides information about the prompts for the specified Amazon Connect instance.


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

      Parameters:
      listPromptsRequest - A Consumer that will call methods on ListPromptsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPrompts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPromptsPaginator

      default ListPromptsPublisher listPromptsPaginator(ListPromptsRequest listPromptsRequest)

      This is a variant of listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) 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.connect.paginators.ListPromptsPublisher publisher = client.listPromptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPromptsPublisher publisher = client.listPromptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPromptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPromptsResponse 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 listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation.

      Parameters:
      listPromptsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPromptsPaginator

      default ListPromptsPublisher listPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest)

      This is a variant of listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) 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.connect.paginators.ListPromptsPublisher publisher = client.listPromptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListPromptsPublisher publisher = client.listPromptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListPromptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListPromptsResponse 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 listPrompts(software.amazon.awssdk.services.connect.model.ListPromptsRequest) operation.


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

      Parameters:
      listPromptsRequest - A Consumer that will call methods on ListPromptsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueueQuickConnects

      default CompletableFuture<ListQueueQuickConnectsResponse> listQueueQuickConnects(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Lists the quick connects associated with a queue.

      Parameters:
      listQueueQuickConnectsRequest -
      Returns:
      A Java Future containing the result of the ListQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueueQuickConnects

      default CompletableFuture<ListQueueQuickConnectsResponse> listQueueQuickConnects(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Lists the quick connects associated with a queue.


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

      Parameters:
      listQueueQuickConnectsRequest - A Consumer that will call methods on ListQueueQuickConnectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueueQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueueQuickConnectsPaginator

      default ListQueueQuickConnectsPublisher listQueueQuickConnectsPaginator(ListQueueQuickConnectsRequest listQueueQuickConnectsRequest)

      This is a variant of listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) 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.connect.paginators.ListQueueQuickConnectsPublisher publisher = client.listQueueQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsPublisher publisher = client.listQueueQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse 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 listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation.

      Parameters:
      listQueueQuickConnectsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueueQuickConnectsPaginator

      default ListQueueQuickConnectsPublisher listQueueQuickConnectsPaginator(Consumer<ListQueueQuickConnectsRequest.Builder> listQueueQuickConnectsRequest)

      This is a variant of listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) 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.connect.paginators.ListQueueQuickConnectsPublisher publisher = client.listQueueQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQueueQuickConnectsPublisher publisher = client.listQueueQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsResponse 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 listQueueQuickConnects(software.amazon.awssdk.services.connect.model.ListQueueQuickConnectsRequest) operation.


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

      Parameters:
      listQueueQuickConnectsRequest - A Consumer that will call methods on ListQueueQuickConnectsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueues

      default CompletableFuture<ListQueuesResponse> listQueues(ListQueuesRequest listQueuesRequest)

      Provides information about the queues for the specified Amazon Connect instance.

      If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

      For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

      Parameters:
      listQueuesRequest -
      Returns:
      A Java Future containing the result of the ListQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueues

      default CompletableFuture<ListQueuesResponse> listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)

      Provides information about the queues for the specified Amazon Connect instance.

      If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

      For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.


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

      Parameters:
      listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueuesPaginator

      default ListQueuesPublisher listQueuesPaginator(ListQueuesRequest listQueuesRequest)

      This is a variant of listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) 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.connect.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQueuesResponse 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 listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation.

      Parameters:
      listQueuesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQueuesPaginator

      default ListQueuesPublisher listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)

      This is a variant of listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) 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.connect.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQueuesResponse 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 listQueues(software.amazon.awssdk.services.connect.model.ListQueuesRequest) operation.


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

      Parameters:
      listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickConnects

      default CompletableFuture<ListQuickConnectsResponse> listQuickConnects(ListQuickConnectsRequest listQuickConnectsRequest)

      Provides information about the quick connects for the specified Amazon Connect instance.

      Parameters:
      listQuickConnectsRequest -
      Returns:
      A Java Future containing the result of the ListQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickConnects

      default CompletableFuture<ListQuickConnectsResponse> listQuickConnects(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest)

      Provides information about the quick connects for the specified Amazon Connect instance.


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

      Parameters:
      listQuickConnectsRequest - A Consumer that will call methods on ListQuickConnectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickConnectsPaginator

      default ListQuickConnectsPublisher listQuickConnectsPaginator(ListQuickConnectsRequest listQuickConnectsRequest)

      This is a variant of listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) 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.connect.paginators.ListQuickConnectsPublisher publisher = client.listQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsPublisher publisher = client.listQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse 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 listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation.

      Parameters:
      listQuickConnectsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickConnectsPaginator

      default ListQuickConnectsPublisher listQuickConnectsPaginator(Consumer<ListQuickConnectsRequest.Builder> listQuickConnectsRequest)

      This is a variant of listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) 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.connect.paginators.ListQuickConnectsPublisher publisher = client.listQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListQuickConnectsPublisher publisher = client.listQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListQuickConnectsResponse 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 listQuickConnects(software.amazon.awssdk.services.connect.model.ListQuickConnectsRequest) operation.


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

      Parameters:
      listQuickConnectsRequest - A Consumer that will call methods on ListQuickConnectsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsV2

      default CompletableFuture<ListRealtimeContactAnalysisSegmentsV2Response> listRealtimeContactAnalysisSegmentsV2(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request)

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

      Parameters:
      listRealtimeContactAnalysisSegmentsV2Request -
      Returns:
      A Java Future containing the result of the ListRealtimeContactAnalysisSegmentsV2 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.
      • OutputTypeNotFoundException Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsV2

      default CompletableFuture<ListRealtimeContactAnalysisSegmentsV2Response> listRealtimeContactAnalysisSegmentsV2(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request)

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


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

      Parameters:
      listRealtimeContactAnalysisSegmentsV2Request - A Consumer that will call methods on ListRealtimeContactAnalysisSegmentsV2Request.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRealtimeContactAnalysisSegmentsV2 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.
      • OutputTypeNotFoundException Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsV2Paginator

      default ListRealtimeContactAnalysisSegmentsV2Publisher listRealtimeContactAnalysisSegmentsV2Paginator(ListRealtimeContactAnalysisSegmentsV2Request listRealtimeContactAnalysisSegmentsV2Request)

      This is a variant of listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request) 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.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Publisher publisher = client.listRealtimeContactAnalysisSegmentsV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Publisher publisher = client.listRealtimeContactAnalysisSegmentsV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response 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 listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request) operation.

      Parameters:
      listRealtimeContactAnalysisSegmentsV2Request -
      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.
      • OutputTypeNotFoundException Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRealtimeContactAnalysisSegmentsV2Paginator

      default ListRealtimeContactAnalysisSegmentsV2Publisher listRealtimeContactAnalysisSegmentsV2Paginator(Consumer<ListRealtimeContactAnalysisSegmentsV2Request.Builder> listRealtimeContactAnalysisSegmentsV2Request)

      This is a variant of listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request) 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.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Publisher publisher = client.listRealtimeContactAnalysisSegmentsV2Paginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRealtimeContactAnalysisSegmentsV2Publisher publisher = client.listRealtimeContactAnalysisSegmentsV2Paginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Response 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 listRealtimeContactAnalysisSegmentsV2(software.amazon.awssdk.services.connect.model.ListRealtimeContactAnalysisSegmentsV2Request) operation.


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

      Parameters:
      listRealtimeContactAnalysisSegmentsV2Request - A Consumer that will call methods on ListRealtimeContactAnalysisSegmentsV2Request.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.
      • OutputTypeNotFoundException Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in Contact flow.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfileQueues

      default CompletableFuture<ListRoutingProfileQueuesResponse> listRoutingProfileQueues(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)

      Lists the queues associated with a routing profile.

      Parameters:
      listRoutingProfileQueuesRequest -
      Returns:
      A Java Future containing the result of the ListRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfileQueues

      default CompletableFuture<ListRoutingProfileQueuesResponse> listRoutingProfileQueues(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest)

      Lists the queues associated with a routing profile.


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

      Parameters:
      listRoutingProfileQueuesRequest - A Consumer that will call methods on ListRoutingProfileQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfileQueuesPaginator

      default ListRoutingProfileQueuesPublisher listRoutingProfileQueuesPaginator(ListRoutingProfileQueuesRequest listRoutingProfileQueuesRequest)

      This is a variant of listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) 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.connect.paginators.ListRoutingProfileQueuesPublisher publisher = client.listRoutingProfileQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesPublisher publisher = client.listRoutingProfileQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse 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 listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation.

      Parameters:
      listRoutingProfileQueuesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfileQueuesPaginator

      default ListRoutingProfileQueuesPublisher listRoutingProfileQueuesPaginator(Consumer<ListRoutingProfileQueuesRequest.Builder> listRoutingProfileQueuesRequest)

      This is a variant of listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) 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.connect.paginators.ListRoutingProfileQueuesPublisher publisher = client.listRoutingProfileQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfileQueuesPublisher publisher = client.listRoutingProfileQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesResponse 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 listRoutingProfileQueues(software.amazon.awssdk.services.connect.model.ListRoutingProfileQueuesRequest) operation.


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

      Parameters:
      listRoutingProfileQueuesRequest - A Consumer that will call methods on ListRoutingProfileQueuesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfiles

      default CompletableFuture<ListRoutingProfilesResponse> listRoutingProfiles(ListRoutingProfilesRequest listRoutingProfilesRequest)

      Provides summary information about the routing profiles for the specified Amazon Connect instance.

      For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

      Parameters:
      listRoutingProfilesRequest -
      Returns:
      A Java Future containing the result of the ListRoutingProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfiles

      default CompletableFuture<ListRoutingProfilesResponse> listRoutingProfiles(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)

      Provides summary information about the routing profiles for the specified Amazon Connect instance.

      For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.


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

      Parameters:
      listRoutingProfilesRequest - A Consumer that will call methods on ListRoutingProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRoutingProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfilesPaginator

      default ListRoutingProfilesPublisher listRoutingProfilesPaginator(ListRoutingProfilesRequest listRoutingProfilesRequest)

      This is a variant of listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) 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.connect.paginators.ListRoutingProfilesPublisher publisher = client.listRoutingProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesPublisher publisher = client.listRoutingProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse 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 listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation.

      Parameters:
      listRoutingProfilesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRoutingProfilesPaginator

      default ListRoutingProfilesPublisher listRoutingProfilesPaginator(Consumer<ListRoutingProfilesRequest.Builder> listRoutingProfilesRequest)

      This is a variant of listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) 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.connect.paginators.ListRoutingProfilesPublisher publisher = client.listRoutingProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRoutingProfilesPublisher publisher = client.listRoutingProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRoutingProfilesResponse 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 listRoutingProfiles(software.amazon.awssdk.services.connect.model.ListRoutingProfilesRequest) operation.


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

      Parameters:
      listRoutingProfilesRequest - A Consumer that will call methods on ListRoutingProfilesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRules

      default CompletableFuture<ListRulesResponse> listRules(ListRulesRequest listRulesRequest)

      List all rules for the specified Amazon Connect instance.

      Parameters:
      listRulesRequest -
      Returns:
      A Java Future containing the result of the ListRules 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRules

      default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)

      List all rules for the specified Amazon Connect instance.


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

      Parameters:
      listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRules 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRulesPaginator

      default ListRulesPublisher listRulesPaginator(ListRulesRequest listRulesRequest)

      This is a variant of listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) 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.connect.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRulesResponse 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 listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation.

      Parameters:
      listRulesRequest -
      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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRulesPaginator

      default ListRulesPublisher listRulesPaginator(Consumer<ListRulesRequest.Builder> listRulesRequest)

      This is a variant of listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) 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.connect.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListRulesPublisher publisher = client.listRulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListRulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListRulesResponse 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 listRules(software.amazon.awssdk.services.connect.model.ListRulesRequest) operation.


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

      Parameters:
      listRulesRequest - A Consumer that will call methods on ListRulesRequest.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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityKeys

      default CompletableFuture<ListSecurityKeysResponse> listSecurityKeys(ListSecurityKeysRequest listSecurityKeysRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all security keys associated with the instance.

      Parameters:
      listSecurityKeysRequest -
      Returns:
      A Java Future containing the result of the ListSecurityKeys 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityKeys

      default CompletableFuture<ListSecurityKeysResponse> listSecurityKeys(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Returns a paginated list of all security keys associated with the instance.


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

      Parameters:
      listSecurityKeysRequest - A Consumer that will call methods on ListSecurityKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityKeys 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityKeysPaginator

      default ListSecurityKeysPublisher listSecurityKeysPaginator(ListSecurityKeysRequest listSecurityKeysRequest)

      This is a variant of listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) 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.connect.paginators.ListSecurityKeysPublisher publisher = client.listSecurityKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysPublisher publisher = client.listSecurityKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse 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 listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation.

      Parameters:
      listSecurityKeysRequest -
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityKeysPaginator

      default ListSecurityKeysPublisher listSecurityKeysPaginator(Consumer<ListSecurityKeysRequest.Builder> listSecurityKeysRequest)

      This is a variant of listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) 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.connect.paginators.ListSecurityKeysPublisher publisher = client.listSecurityKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityKeysPublisher publisher = client.listSecurityKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityKeysResponse 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 listSecurityKeys(software.amazon.awssdk.services.connect.model.ListSecurityKeysRequest) operation.


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

      Parameters:
      listSecurityKeysRequest - A Consumer that will call methods on ListSecurityKeysRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfileApplications

      default CompletableFuture<ListSecurityProfileApplicationsResponse> listSecurityProfileApplications(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest)

      Returns a list of third-party applications in a specific security profile.

      Parameters:
      listSecurityProfileApplicationsRequest -
      Returns:
      A Java Future containing the result of the ListSecurityProfileApplications 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfileApplications

      default CompletableFuture<ListSecurityProfileApplicationsResponse> listSecurityProfileApplications(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest)

      Returns a list of third-party applications in a specific security profile.


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

      Parameters:
      listSecurityProfileApplicationsRequest - A Consumer that will call methods on ListSecurityProfileApplicationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityProfileApplications 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfileApplicationsPaginator

      default ListSecurityProfileApplicationsPublisher listSecurityProfileApplicationsPaginator(ListSecurityProfileApplicationsRequest listSecurityProfileApplicationsRequest)

      This is a variant of listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest) 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.connect.paginators.ListSecurityProfileApplicationsPublisher publisher = client.listSecurityProfileApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsPublisher publisher = client.listSecurityProfileApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse 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 listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest) operation.

      Parameters:
      listSecurityProfileApplicationsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfileApplicationsPaginator

      default ListSecurityProfileApplicationsPublisher listSecurityProfileApplicationsPaginator(Consumer<ListSecurityProfileApplicationsRequest.Builder> listSecurityProfileApplicationsRequest)

      This is a variant of listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest) 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.connect.paginators.ListSecurityProfileApplicationsPublisher publisher = client.listSecurityProfileApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfileApplicationsPublisher publisher = client.listSecurityProfileApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsResponse 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 listSecurityProfileApplications(software.amazon.awssdk.services.connect.model.ListSecurityProfileApplicationsRequest) operation.


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

      Parameters:
      listSecurityProfileApplicationsRequest - A Consumer that will call methods on ListSecurityProfileApplicationsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilePermissions

      default CompletableFuture<ListSecurityProfilePermissionsResponse> listSecurityProfilePermissions(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)

      Lists the permissions granted to a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      listSecurityProfilePermissionsRequest -
      Returns:
      A Java Future containing the result of the ListSecurityProfilePermissions 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilePermissions

      default CompletableFuture<ListSecurityProfilePermissionsResponse> listSecurityProfilePermissions(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest)

      Lists the permissions granted to a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      listSecurityProfilePermissionsRequest - A Consumer that will call methods on ListSecurityProfilePermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityProfilePermissions 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilePermissionsPaginator

      default ListSecurityProfilePermissionsPublisher listSecurityProfilePermissionsPaginator(ListSecurityProfilePermissionsRequest listSecurityProfilePermissionsRequest)

      This is a variant of listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) 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.connect.paginators.ListSecurityProfilePermissionsPublisher publisher = client.listSecurityProfilePermissionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsPublisher publisher = client.listSecurityProfilePermissionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse 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 listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation.

      Parameters:
      listSecurityProfilePermissionsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilePermissionsPaginator

      default ListSecurityProfilePermissionsPublisher listSecurityProfilePermissionsPaginator(Consumer<ListSecurityProfilePermissionsRequest.Builder> listSecurityProfilePermissionsRequest)

      This is a variant of listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) 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.connect.paginators.ListSecurityProfilePermissionsPublisher publisher = client.listSecurityProfilePermissionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilePermissionsPublisher publisher = client.listSecurityProfilePermissionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsResponse 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 listSecurityProfilePermissions(software.amazon.awssdk.services.connect.model.ListSecurityProfilePermissionsRequest) operation.


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

      Parameters:
      listSecurityProfilePermissionsRequest - A Consumer that will call methods on ListSecurityProfilePermissionsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfiles

      default CompletableFuture<ListSecurityProfilesResponse> listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)

      Provides summary information about the security profiles for the specified Amazon Connect instance.

      For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      listSecurityProfilesRequest -
      Returns:
      A Java Future containing the result of the ListSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfiles

      default CompletableFuture<ListSecurityProfilesResponse> listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)

      Provides summary information about the security profiles for the specified Amazon Connect instance.

      For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      listSecurityProfilesRequest - A Consumer that will call methods on ListSecurityProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilesPaginator

      default ListSecurityProfilesPublisher listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest)

      This is a variant of listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) 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.connect.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse 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 listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation.

      Parameters:
      listSecurityProfilesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSecurityProfilesPaginator

      default ListSecurityProfilesPublisher listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)

      This is a variant of listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) 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.connect.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListSecurityProfilesResponse 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 listSecurityProfiles(software.amazon.awssdk.services.connect.model.ListSecurityProfilesRequest) operation.


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

      Parameters:
      listSecurityProfilesRequest - A Consumer that will call methods on ListSecurityProfilesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException 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 for the specified resource.

      For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException 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 for the specified resource.

      For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.


      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:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskTemplates

      default CompletableFuture<ListTaskTemplatesResponse> listTaskTemplates(ListTaskTemplatesRequest listTaskTemplatesRequest)

      Lists task templates for the specified Amazon Connect instance.

      Parameters:
      listTaskTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListTaskTemplates 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskTemplates

      default CompletableFuture<ListTaskTemplatesResponse> listTaskTemplates(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest)

      Lists task templates for the specified Amazon Connect instance.


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

      Parameters:
      listTaskTemplatesRequest - A Consumer that will call methods on ListTaskTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTaskTemplates 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskTemplatesPaginator

      default ListTaskTemplatesPublisher listTaskTemplatesPaginator(ListTaskTemplatesRequest listTaskTemplatesRequest)

      This is a variant of listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) 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.connect.paginators.ListTaskTemplatesPublisher publisher = client.listTaskTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesPublisher publisher = client.listTaskTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse 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 listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation.

      Parameters:
      listTaskTemplatesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskTemplatesPaginator

      default ListTaskTemplatesPublisher listTaskTemplatesPaginator(Consumer<ListTaskTemplatesRequest.Builder> listTaskTemplatesRequest)

      This is a variant of listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) 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.connect.paginators.ListTaskTemplatesPublisher publisher = client.listTaskTemplatesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTaskTemplatesPublisher publisher = client.listTaskTemplatesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTaskTemplatesResponse 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 listTaskTemplates(software.amazon.awssdk.services.connect.model.ListTaskTemplatesRequest) operation.


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

      Parameters:
      listTaskTemplatesRequest - A Consumer that will call methods on ListTaskTemplatesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroupUsers

      default CompletableFuture<ListTrafficDistributionGroupUsersResponse> listTrafficDistributionGroupUsers(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)

      Lists traffic distribution group users.

      Parameters:
      listTrafficDistributionGroupUsersRequest -
      Returns:
      A Java Future containing the result of the ListTrafficDistributionGroupUsers 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.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroupUsers

      default CompletableFuture<ListTrafficDistributionGroupUsersResponse> listTrafficDistributionGroupUsers(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest)

      Lists traffic distribution group users.


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

      Parameters:
      listTrafficDistributionGroupUsersRequest - A Consumer that will call methods on ListTrafficDistributionGroupUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrafficDistributionGroupUsers 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.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroupUsersPaginator

      default ListTrafficDistributionGroupUsersPublisher listTrafficDistributionGroupUsersPaginator(ListTrafficDistributionGroupUsersRequest listTrafficDistributionGroupUsersRequest)

      This is a variant of listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) 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.connect.paginators.ListTrafficDistributionGroupUsersPublisher publisher = client.listTrafficDistributionGroupUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersPublisher publisher = client.listTrafficDistributionGroupUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse 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 listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation.

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

    • listTrafficDistributionGroupUsersPaginator

      default ListTrafficDistributionGroupUsersPublisher listTrafficDistributionGroupUsersPaginator(Consumer<ListTrafficDistributionGroupUsersRequest.Builder> listTrafficDistributionGroupUsersRequest)

      This is a variant of listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) 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.connect.paginators.ListTrafficDistributionGroupUsersPublisher publisher = client.listTrafficDistributionGroupUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupUsersPublisher publisher = client.listTrafficDistributionGroupUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersResponse 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 listTrafficDistributionGroupUsers(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupUsersRequest) operation.


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

      Parameters:
      listTrafficDistributionGroupUsersRequest - A Consumer that will call methods on ListTrafficDistributionGroupUsersRequest.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.
      • ResourceNotFoundException The specified resource was not found.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroups

      default CompletableFuture<ListTrafficDistributionGroupsResponse> listTrafficDistributionGroups(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)

      Lists traffic distribution groups.

      Parameters:
      listTrafficDistributionGroupsRequest -
      Returns:
      A Java Future containing the result of the ListTrafficDistributionGroups 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroups

      default CompletableFuture<ListTrafficDistributionGroupsResponse> listTrafficDistributionGroups(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest)

      Lists traffic distribution groups.


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

      Parameters:
      listTrafficDistributionGroupsRequest - A Consumer that will call methods on ListTrafficDistributionGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTrafficDistributionGroups 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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroupsPaginator

      default ListTrafficDistributionGroupsPublisher listTrafficDistributionGroupsPaginator(ListTrafficDistributionGroupsRequest listTrafficDistributionGroupsRequest)

      This is a variant of listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) 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.connect.paginators.ListTrafficDistributionGroupsPublisher publisher = client.listTrafficDistributionGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsPublisher publisher = client.listTrafficDistributionGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse 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 listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation.

      Parameters:
      listTrafficDistributionGroupsRequest -
      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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTrafficDistributionGroupsPaginator

      default ListTrafficDistributionGroupsPublisher listTrafficDistributionGroupsPaginator(Consumer<ListTrafficDistributionGroupsRequest.Builder> listTrafficDistributionGroupsRequest)

      This is a variant of listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) 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.connect.paginators.ListTrafficDistributionGroupsPublisher publisher = client.listTrafficDistributionGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListTrafficDistributionGroupsPublisher publisher = client.listTrafficDistributionGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsResponse 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 listTrafficDistributionGroups(software.amazon.awssdk.services.connect.model.ListTrafficDistributionGroupsRequest) operation.


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

      Parameters:
      listTrafficDistributionGroupsRequest - A Consumer that will call methods on ListTrafficDistributionGroupsRequest.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 permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUseCases

      default CompletableFuture<ListUseCasesResponse> listUseCases(ListUseCasesRequest listUseCasesRequest)

      Lists the use cases for the integration association.

      Parameters:
      listUseCasesRequest - Provides summary information about the use cases for the specified integration association.
      Returns:
      A Java Future containing the result of the ListUseCases 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUseCases

      default CompletableFuture<ListUseCasesResponse> listUseCases(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest)

      Lists the use cases for the integration association.


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

      Parameters:
      listUseCasesRequest - A Consumer that will call methods on ListUseCasesRequest.Builder to create a request. Provides summary information about the use cases for the specified integration association.
      Returns:
      A Java Future containing the result of the ListUseCases 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUseCasesPaginator

      default ListUseCasesPublisher listUseCasesPaginator(ListUseCasesRequest listUseCasesRequest)

      This is a variant of listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) 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.connect.paginators.ListUseCasesPublisher publisher = client.listUseCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUseCasesPublisher publisher = client.listUseCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUseCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUseCasesResponse 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 listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation.

      Parameters:
      listUseCasesRequest - Provides summary information about the use cases for the specified integration association.
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUseCasesPaginator

      default ListUseCasesPublisher listUseCasesPaginator(Consumer<ListUseCasesRequest.Builder> listUseCasesRequest)

      This is a variant of listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) 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.connect.paginators.ListUseCasesPublisher publisher = client.listUseCasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUseCasesPublisher publisher = client.listUseCasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUseCasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUseCasesResponse 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 listUseCases(software.amazon.awssdk.services.connect.model.ListUseCasesRequest) operation.


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

      Parameters:
      listUseCasesRequest - A Consumer that will call methods on ListUseCasesRequest.Builder to create a request. Provides summary information about the use cases for the specified integration association.
      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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserHierarchyGroups

      default CompletableFuture<ListUserHierarchyGroupsResponse> listUserHierarchyGroups(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)

      Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

      For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

      Parameters:
      listUserHierarchyGroupsRequest -
      Returns:
      A Java Future containing the result of the ListUserHierarchyGroups 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserHierarchyGroups

      default CompletableFuture<ListUserHierarchyGroupsResponse> listUserHierarchyGroups(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)

      Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

      For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.


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

      Parameters:
      listUserHierarchyGroupsRequest - A Consumer that will call methods on ListUserHierarchyGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUserHierarchyGroups 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserHierarchyGroupsPaginator

      default ListUserHierarchyGroupsPublisher listUserHierarchyGroupsPaginator(ListUserHierarchyGroupsRequest listUserHierarchyGroupsRequest)

      This is a variant of listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) 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.connect.paginators.ListUserHierarchyGroupsPublisher publisher = client.listUserHierarchyGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsPublisher publisher = client.listUserHierarchyGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse 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 listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation.

      Parameters:
      listUserHierarchyGroupsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserHierarchyGroupsPaginator

      default ListUserHierarchyGroupsPublisher listUserHierarchyGroupsPaginator(Consumer<ListUserHierarchyGroupsRequest.Builder> listUserHierarchyGroupsRequest)

      This is a variant of listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) 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.connect.paginators.ListUserHierarchyGroupsPublisher publisher = client.listUserHierarchyGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUserHierarchyGroupsPublisher publisher = client.listUserHierarchyGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsResponse 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 listUserHierarchyGroups(software.amazon.awssdk.services.connect.model.ListUserHierarchyGroupsRequest) operation.


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

      Parameters:
      listUserHierarchyGroupsRequest - A Consumer that will call methods on ListUserHierarchyGroupsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProficiencies

      default CompletableFuture<ListUserProficienciesResponse> listUserProficiencies(ListUserProficienciesRequest listUserProficienciesRequest)

      Lists proficiencies associated with a user.

      Parameters:
      listUserProficienciesRequest -
      Returns:
      A Java Future containing the result of the ListUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProficiencies

      default CompletableFuture<ListUserProficienciesResponse> listUserProficiencies(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest)

      Lists proficiencies associated with a user.


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

      Parameters:
      listUserProficienciesRequest - A Consumer that will call methods on ListUserProficienciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProficienciesPaginator

      default ListUserProficienciesPublisher listUserProficienciesPaginator(ListUserProficienciesRequest listUserProficienciesRequest)

      This is a variant of listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest) 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.connect.paginators.ListUserProficienciesPublisher publisher = client.listUserProficienciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUserProficienciesPublisher publisher = client.listUserProficienciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse 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 listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest) operation.

      Parameters:
      listUserProficienciesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUserProficienciesPaginator

      default ListUserProficienciesPublisher listUserProficienciesPaginator(Consumer<ListUserProficienciesRequest.Builder> listUserProficienciesRequest)

      This is a variant of listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest) 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.connect.paginators.ListUserProficienciesPublisher publisher = client.listUserProficienciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUserProficienciesPublisher publisher = client.listUserProficienciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUserProficienciesResponse 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 listUserProficiencies(software.amazon.awssdk.services.connect.model.ListUserProficienciesRequest) operation.


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

      Parameters:
      listUserProficienciesRequest - A Consumer that will call methods on ListUserProficienciesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)

      Provides summary information about the users for the specified Amazon Connect instance.

      Parameters:
      listUsersRequest -
      Returns:
      A Java Future containing the result of the ListUsers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsers

      default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)

      Provides summary information about the users for the specified Amazon Connect instance.


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

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListUsers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) 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.connect.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUsersResponse 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 listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation.

      Parameters:
      listUsersRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listUsersPaginator

      default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)

      This is a variant of listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) 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.connect.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListUsersResponse 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 listUsers(software.amazon.awssdk.services.connect.model.ListUsersRequest) operation.


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

      Parameters:
      listUsersRequest - A Consumer that will call methods on ListUsersRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewVersions

      default CompletableFuture<ListViewVersionsResponse> listViewVersions(ListViewVersionsRequest listViewVersionsRequest)

      Returns all the available versions for the specified Amazon Connect instance and view identifier.

      Results will be sorted from highest to lowest.

      Parameters:
      listViewVersionsRequest -
      Returns:
      A Java Future containing the result of the ListViewVersions 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewVersions

      default CompletableFuture<ListViewVersionsResponse> listViewVersions(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest)

      Returns all the available versions for the specified Amazon Connect instance and view identifier.

      Results will be sorted from highest to lowest.


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

      Parameters:
      listViewVersionsRequest - A Consumer that will call methods on ListViewVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListViewVersions 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewVersionsPaginator

      default ListViewVersionsPublisher listViewVersionsPaginator(ListViewVersionsRequest listViewVersionsRequest)

      This is a variant of listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest) 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.connect.paginators.ListViewVersionsPublisher publisher = client.listViewVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListViewVersionsPublisher publisher = client.listViewVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListViewVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListViewVersionsResponse 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 listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest) operation.

      Parameters:
      listViewVersionsRequest -
      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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewVersionsPaginator

      default ListViewVersionsPublisher listViewVersionsPaginator(Consumer<ListViewVersionsRequest.Builder> listViewVersionsRequest)

      This is a variant of listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest) 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.connect.paginators.ListViewVersionsPublisher publisher = client.listViewVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListViewVersionsPublisher publisher = client.listViewVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListViewVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListViewVersionsResponse 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 listViewVersions(software.amazon.awssdk.services.connect.model.ListViewVersionsRequest) operation.


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

      Parameters:
      listViewVersionsRequest - A Consumer that will call methods on ListViewVersionsRequest.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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViews

      default CompletableFuture<ListViewsResponse> listViews(ListViewsRequest listViewsRequest)

      Returns views in the given instance.

      Results are sorted primarily by type, and secondarily by name.

      Parameters:
      listViewsRequest -
      Returns:
      A Java Future containing the result of the ListViews 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViews

      default CompletableFuture<ListViewsResponse> listViews(Consumer<ListViewsRequest.Builder> listViewsRequest)

      Returns views in the given instance.

      Results are sorted primarily by type, and secondarily by name.


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

      Parameters:
      listViewsRequest - A Consumer that will call methods on ListViewsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListViews 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewsPaginator

      default ListViewsPublisher listViewsPaginator(ListViewsRequest listViewsRequest)

      This is a variant of listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest) 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.connect.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListViewsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListViewsResponse 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 listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest) operation.

      Parameters:
      listViewsRequest -
      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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listViewsPaginator

      default ListViewsPublisher listViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest)

      This is a variant of listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest) 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.connect.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.ListViewsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.ListViewsResponse 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 listViews(software.amazon.awssdk.services.connect.model.ListViewsRequest) operation.


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

      Parameters:
      listViewsRequest - A Consumer that will call methods on ListViewsRequest.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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • monitorContact

      default CompletableFuture<MonitorContactResponse> monitorContact(MonitorContactRequest monitorContactRequest)

      Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.

      Parameters:
      monitorContactRequest -
      Returns:
      A Java Future containing the result of the MonitorContact 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.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • monitorContact

      default CompletableFuture<MonitorContactResponse> monitorContact(Consumer<MonitorContactRequest.Builder> monitorContactRequest)

      Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.


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

      Parameters:
      monitorContactRequest - A Consumer that will call methods on MonitorContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the MonitorContact 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.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • pauseContact

      default CompletableFuture<PauseContactResponse> pauseContact(PauseContactRequest pauseContactRequest)

      Allows pausing an ongoing task contact.

      Parameters:
      pauseContactRequest -
      Returns:
      A Java Future containing the result of the PauseContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • pauseContact

      default CompletableFuture<PauseContactResponse> pauseContact(Consumer<PauseContactRequest.Builder> pauseContactRequest)

      Allows pausing an ongoing task contact.


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

      Parameters:
      pauseContactRequest - A Consumer that will call methods on PauseContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PauseContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putUserStatus

      default CompletableFuture<PutUserStatusResponse> putUserStatus(PutUserStatusRequest putUserStatusRequest)

      Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

      For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.

      Parameters:
      putUserStatusRequest -
      Returns:
      A Java Future containing the result of the PutUserStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putUserStatus

      default CompletableFuture<PutUserStatusResponse> putUserStatus(Consumer<PutUserStatusRequest.Builder> putUserStatusRequest)

      Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

      For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.


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

      Parameters:
      putUserStatusRequest - A Consumer that will call methods on PutUserStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutUserStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releasePhoneNumber

      default CompletableFuture<ReleasePhoneNumberResponse> releasePhoneNumber(ReleasePhoneNumberRequest releasePhoneNumberRequest)

      Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

      To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

      After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

      If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.

      Parameters:
      releasePhoneNumberRequest -
      Returns:
      A Java Future containing the result of the ReleasePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releasePhoneNumber

      default CompletableFuture<ReleasePhoneNumberResponse> releasePhoneNumber(Consumer<ReleasePhoneNumberRequest.Builder> releasePhoneNumberRequest)

      Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.

      To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website.

      After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.

      If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

      By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.

      For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.


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

      Parameters:
      releasePhoneNumberRequest - A Consumer that will call methods on ReleasePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ReleasePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • replicateInstance

      default CompletableFuture<ReplicateInstanceResponse> replicateInstance(ReplicateInstanceRequest replicateInstanceRequest)

      Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

      For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.

      Parameters:
      replicateInstanceRequest -
      Returns:
      A Java Future containing the result of the ReplicateInstance 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 permissions to perform this action.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotReadyException The resource is not ready.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • replicateInstance

      default CompletableFuture<ReplicateInstanceResponse> replicateInstance(Consumer<ReplicateInstanceRequest.Builder> replicateInstanceRequest)

      Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.

      For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.


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

      Parameters:
      replicateInstanceRequest - A Consumer that will call methods on ReplicateInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ReplicateInstance 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 permissions to perform this action.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotReadyException The resource is not ready.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeContact

      default CompletableFuture<ResumeContactResponse> resumeContact(ResumeContactRequest resumeContactRequest)

      Allows resuming a task contact in a paused state.

      Parameters:
      resumeContactRequest -
      Returns:
      A Java Future containing the result of the ResumeContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeContact

      default CompletableFuture<ResumeContactResponse> resumeContact(Consumer<ResumeContactRequest.Builder> resumeContactRequest)

      Allows resuming a task contact in a paused state.


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

      Parameters:
      resumeContactRequest - A Consumer that will call methods on ResumeContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResumeContact 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeContactRecording

      default CompletableFuture<ResumeContactRecordingResponse> resumeContactRecording(ResumeContactRecordingRequest resumeContactRecordingRequest)

      When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

      Voice and screen recordings are supported.

      Parameters:
      resumeContactRecordingRequest -
      Returns:
      A Java Future containing the result of the ResumeContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resumeContactRecording

      default CompletableFuture<ResumeContactRecordingResponse> resumeContactRecording(Consumer<ResumeContactRecordingRequest.Builder> resumeContactRecordingRequest)

      When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

      Voice and screen recordings are supported.


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

      Parameters:
      resumeContactRecordingRequest - A Consumer that will call methods on ResumeContactRecordingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResumeContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAgentStatuses

      default CompletableFuture<SearchAgentStatusesResponse> searchAgentStatuses(SearchAgentStatusesRequest searchAgentStatusesRequest)

      Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchAgentStatusesRequest -
      Returns:
      A Java Future containing the result of the SearchAgentStatuses 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAgentStatuses

      default CompletableFuture<SearchAgentStatusesResponse> searchAgentStatuses(Consumer<SearchAgentStatusesRequest.Builder> searchAgentStatusesRequest)

      Searches AgentStatuses in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchAgentStatusesRequest - A Consumer that will call methods on SearchAgentStatusesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchAgentStatuses 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAgentStatusesPaginator

      default SearchAgentStatusesPublisher searchAgentStatusesPaginator(SearchAgentStatusesRequest searchAgentStatusesRequest)

      This is a variant of searchAgentStatuses(software.amazon.awssdk.services.connect.model.SearchAgentStatusesRequest) 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.connect.paginators.SearchAgentStatusesPublisher publisher = client.searchAgentStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchAgentStatusesPublisher publisher = client.searchAgentStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchAgentStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchAgentStatusesResponse 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 searchAgentStatuses(software.amazon.awssdk.services.connect.model.SearchAgentStatusesRequest) operation.

      Parameters:
      searchAgentStatusesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAgentStatusesPaginator

      default SearchAgentStatusesPublisher searchAgentStatusesPaginator(Consumer<SearchAgentStatusesRequest.Builder> searchAgentStatusesRequest)

      This is a variant of searchAgentStatuses(software.amazon.awssdk.services.connect.model.SearchAgentStatusesRequest) 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.connect.paginators.SearchAgentStatusesPublisher publisher = client.searchAgentStatusesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchAgentStatusesPublisher publisher = client.searchAgentStatusesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchAgentStatusesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchAgentStatusesResponse 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 searchAgentStatuses(software.amazon.awssdk.services.connect.model.SearchAgentStatusesRequest) operation.


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

      Parameters:
      searchAgentStatusesRequest - A Consumer that will call methods on SearchAgentStatusesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbers

      default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)

      Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

      Parameters:
      searchAvailablePhoneNumbersRequest -
      Returns:
      A Java Future containing the result of the SearchAvailablePhoneNumbers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbers

      default CompletableFuture<SearchAvailablePhoneNumbersResponse> searchAvailablePhoneNumbers(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)

      Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.


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

      Parameters:
      searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchAvailablePhoneNumbers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbersPaginator

      default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(SearchAvailablePhoneNumbersRequest searchAvailablePhoneNumbersRequest)

      This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) 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.connect.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse 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 searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation.

      Parameters:
      searchAvailablePhoneNumbersRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchAvailablePhoneNumbersPaginator

      default SearchAvailablePhoneNumbersPublisher searchAvailablePhoneNumbersPaginator(Consumer<SearchAvailablePhoneNumbersRequest.Builder> searchAvailablePhoneNumbersRequest)

      This is a variant of searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) 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.connect.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchAvailablePhoneNumbersPublisher publisher = client.searchAvailablePhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersResponse 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 searchAvailablePhoneNumbers(software.amazon.awssdk.services.connect.model.SearchAvailablePhoneNumbersRequest) operation.


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

      Parameters:
      searchAvailablePhoneNumbersRequest - A Consumer that will call methods on SearchAvailablePhoneNumbersRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowModules

      default CompletableFuture<SearchContactFlowModulesResponse> searchContactFlowModules(SearchContactFlowModulesRequest searchContactFlowModulesRequest)

      Searches the flow modules in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchContactFlowModulesRequest -
      Returns:
      A Java Future containing the result of the SearchContactFlowModules 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowModules

      default CompletableFuture<SearchContactFlowModulesResponse> searchContactFlowModules(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest)

      Searches the flow modules in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchContactFlowModulesRequest - A Consumer that will call methods on SearchContactFlowModulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchContactFlowModules 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowModulesPaginator

      default SearchContactFlowModulesPublisher searchContactFlowModulesPaginator(SearchContactFlowModulesRequest searchContactFlowModulesRequest)

      This is a variant of searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest) 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.connect.paginators.SearchContactFlowModulesPublisher publisher = client.searchContactFlowModulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesPublisher publisher = client.searchContactFlowModulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse 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 searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest) operation.

      Parameters:
      searchContactFlowModulesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowModulesPaginator

      default SearchContactFlowModulesPublisher searchContactFlowModulesPaginator(Consumer<SearchContactFlowModulesRequest.Builder> searchContactFlowModulesRequest)

      This is a variant of searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest) 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.connect.paginators.SearchContactFlowModulesPublisher publisher = client.searchContactFlowModulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactFlowModulesPublisher publisher = client.searchContactFlowModulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesResponse 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 searchContactFlowModules(software.amazon.awssdk.services.connect.model.SearchContactFlowModulesRequest) operation.


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

      Parameters:
      searchContactFlowModulesRequest - A Consumer that will call methods on SearchContactFlowModulesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlows

      default CompletableFuture<SearchContactFlowsResponse> searchContactFlows(SearchContactFlowsRequest searchContactFlowsRequest)

      Searches the contact flows in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchContactFlowsRequest -
      Returns:
      A Java Future containing the result of the SearchContactFlows 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlows

      default CompletableFuture<SearchContactFlowsResponse> searchContactFlows(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest)

      Searches the contact flows in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchContactFlowsRequest - A Consumer that will call methods on SearchContactFlowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchContactFlows 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowsPaginator

      default SearchContactFlowsPublisher searchContactFlowsPaginator(SearchContactFlowsRequest searchContactFlowsRequest)

      This is a variant of searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest) 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.connect.paginators.SearchContactFlowsPublisher publisher = client.searchContactFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactFlowsPublisher publisher = client.searchContactFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse 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 searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest) operation.

      Parameters:
      searchContactFlowsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactFlowsPaginator

      default SearchContactFlowsPublisher searchContactFlowsPaginator(Consumer<SearchContactFlowsRequest.Builder> searchContactFlowsRequest)

      This is a variant of searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest) 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.connect.paginators.SearchContactFlowsPublisher publisher = client.searchContactFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactFlowsPublisher publisher = client.searchContactFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactFlowsResponse 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 searchContactFlows(software.amazon.awssdk.services.connect.model.SearchContactFlowsRequest) operation.


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

      Parameters:
      searchContactFlowsRequest - A Consumer that will call methods on SearchContactFlowsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContacts

      default CompletableFuture<SearchContactsResponse> searchContacts(SearchContactsRequest searchContactsRequest)

      Searches contacts in an Amazon Connect instance.

      Parameters:
      searchContactsRequest -
      Returns:
      A Java Future containing the result of the SearchContacts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContacts

      default CompletableFuture<SearchContactsResponse> searchContacts(Consumer<SearchContactsRequest.Builder> searchContactsRequest)

      Searches contacts in an Amazon Connect instance.


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

      Parameters:
      searchContactsRequest - A Consumer that will call methods on SearchContactsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchContacts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactsPaginator

      default SearchContactsPublisher searchContactsPaginator(SearchContactsRequest searchContactsRequest)

      This is a variant of searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest) 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.connect.paginators.SearchContactsPublisher publisher = client.searchContactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactsPublisher publisher = client.searchContactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactsResponse 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 searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest) operation.

      Parameters:
      searchContactsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContactsPaginator

      default SearchContactsPublisher searchContactsPaginator(Consumer<SearchContactsRequest.Builder> searchContactsRequest)

      This is a variant of searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest) 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.connect.paginators.SearchContactsPublisher publisher = client.searchContactsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchContactsPublisher publisher = client.searchContactsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchContactsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchContactsResponse 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 searchContacts(software.amazon.awssdk.services.connect.model.SearchContactsRequest) operation.


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

      Parameters:
      searchContactsRequest - A Consumer that will call methods on SearchContactsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchHoursOfOperations

      default CompletableFuture<SearchHoursOfOperationsResponse> searchHoursOfOperations(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)

      Searches the hours of operation in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchHoursOfOperationsRequest -
      Returns:
      A Java Future containing the result of the SearchHoursOfOperations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchHoursOfOperations

      default CompletableFuture<SearchHoursOfOperationsResponse> searchHoursOfOperations(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest)

      Searches the hours of operation in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchHoursOfOperationsRequest - A Consumer that will call methods on SearchHoursOfOperationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchHoursOfOperations 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchHoursOfOperationsPaginator

      default SearchHoursOfOperationsPublisher searchHoursOfOperationsPaginator(SearchHoursOfOperationsRequest searchHoursOfOperationsRequest)

      This is a variant of searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) 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.connect.paginators.SearchHoursOfOperationsPublisher publisher = client.searchHoursOfOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsPublisher publisher = client.searchHoursOfOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse 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 searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation.

      Parameters:
      searchHoursOfOperationsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchHoursOfOperationsPaginator

      default SearchHoursOfOperationsPublisher searchHoursOfOperationsPaginator(Consumer<SearchHoursOfOperationsRequest.Builder> searchHoursOfOperationsRequest)

      This is a variant of searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) 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.connect.paginators.SearchHoursOfOperationsPublisher publisher = client.searchHoursOfOperationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchHoursOfOperationsPublisher publisher = client.searchHoursOfOperationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsResponse 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 searchHoursOfOperations(software.amazon.awssdk.services.connect.model.SearchHoursOfOperationsRequest) operation.


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

      Parameters:
      searchHoursOfOperationsRequest - A Consumer that will call methods on SearchHoursOfOperationsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPredefinedAttributes

      default CompletableFuture<SearchPredefinedAttributesResponse> searchPredefinedAttributes(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest)

      Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

      Parameters:
      searchPredefinedAttributesRequest -
      Returns:
      A Java Future containing the result of the SearchPredefinedAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPredefinedAttributes

      default CompletableFuture<SearchPredefinedAttributesResponse> searchPredefinedAttributes(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest)

      Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.


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

      Parameters:
      searchPredefinedAttributesRequest - A Consumer that will call methods on SearchPredefinedAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchPredefinedAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPredefinedAttributesPaginator

      default SearchPredefinedAttributesPublisher searchPredefinedAttributesPaginator(SearchPredefinedAttributesRequest searchPredefinedAttributesRequest)

      This is a variant of searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest) 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.connect.paginators.SearchPredefinedAttributesPublisher publisher = client.searchPredefinedAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesPublisher publisher = client.searchPredefinedAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse 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 searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest) operation.

      Parameters:
      searchPredefinedAttributesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPredefinedAttributesPaginator

      default SearchPredefinedAttributesPublisher searchPredefinedAttributesPaginator(Consumer<SearchPredefinedAttributesRequest.Builder> searchPredefinedAttributesRequest)

      This is a variant of searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest) 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.connect.paginators.SearchPredefinedAttributesPublisher publisher = client.searchPredefinedAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchPredefinedAttributesPublisher publisher = client.searchPredefinedAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesResponse 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 searchPredefinedAttributes(software.amazon.awssdk.services.connect.model.SearchPredefinedAttributesRequest) operation.


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

      Parameters:
      searchPredefinedAttributesRequest - A Consumer that will call methods on SearchPredefinedAttributesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPrompts

      default CompletableFuture<SearchPromptsResponse> searchPrompts(SearchPromptsRequest searchPromptsRequest)

      Searches prompts in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchPromptsRequest -
      Returns:
      A Java Future containing the result of the SearchPrompts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPrompts

      default CompletableFuture<SearchPromptsResponse> searchPrompts(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest)

      Searches prompts in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchPromptsRequest - A Consumer that will call methods on SearchPromptsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchPrompts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPromptsPaginator

      default SearchPromptsPublisher searchPromptsPaginator(SearchPromptsRequest searchPromptsRequest)

      This is a variant of searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) 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.connect.paginators.SearchPromptsPublisher publisher = client.searchPromptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchPromptsPublisher publisher = client.searchPromptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchPromptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchPromptsResponse 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 searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation.

      Parameters:
      searchPromptsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchPromptsPaginator

      default SearchPromptsPublisher searchPromptsPaginator(Consumer<SearchPromptsRequest.Builder> searchPromptsRequest)

      This is a variant of searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) 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.connect.paginators.SearchPromptsPublisher publisher = client.searchPromptsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchPromptsPublisher publisher = client.searchPromptsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchPromptsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchPromptsResponse 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 searchPrompts(software.amazon.awssdk.services.connect.model.SearchPromptsRequest) operation.


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

      Parameters:
      searchPromptsRequest - A Consumer that will call methods on SearchPromptsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQueues

      default CompletableFuture<SearchQueuesResponse> searchQueues(SearchQueuesRequest searchQueuesRequest)

      Searches queues in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchQueuesRequest -
      Returns:
      A Java Future containing the result of the SearchQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQueues

      default CompletableFuture<SearchQueuesResponse> searchQueues(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest)

      Searches queues in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchQueuesRequest - A Consumer that will call methods on SearchQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQueuesPaginator

      default SearchQueuesPublisher searchQueuesPaginator(SearchQueuesRequest searchQueuesRequest)

      This is a variant of searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) 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.connect.paginators.SearchQueuesPublisher publisher = client.searchQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchQueuesPublisher publisher = client.searchQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchQueuesResponse 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 searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation.

      Parameters:
      searchQueuesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQueuesPaginator

      default SearchQueuesPublisher searchQueuesPaginator(Consumer<SearchQueuesRequest.Builder> searchQueuesRequest)

      This is a variant of searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) 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.connect.paginators.SearchQueuesPublisher publisher = client.searchQueuesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchQueuesPublisher publisher = client.searchQueuesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchQueuesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchQueuesResponse 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 searchQueues(software.amazon.awssdk.services.connect.model.SearchQueuesRequest) operation.


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

      Parameters:
      searchQueuesRequest - A Consumer that will call methods on SearchQueuesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickConnects

      default CompletableFuture<SearchQuickConnectsResponse> searchQuickConnects(SearchQuickConnectsRequest searchQuickConnectsRequest)

      Searches quick connects in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchQuickConnectsRequest -
      Returns:
      A Java Future containing the result of the SearchQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickConnects

      default CompletableFuture<SearchQuickConnectsResponse> searchQuickConnects(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest)

      Searches quick connects in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchQuickConnectsRequest - A Consumer that will call methods on SearchQuickConnectsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchQuickConnects 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickConnectsPaginator

      default SearchQuickConnectsPublisher searchQuickConnectsPaginator(SearchQuickConnectsRequest searchQuickConnectsRequest)

      This is a variant of searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) 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.connect.paginators.SearchQuickConnectsPublisher publisher = client.searchQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsPublisher publisher = client.searchQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse 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 searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation.

      Parameters:
      searchQuickConnectsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickConnectsPaginator

      default SearchQuickConnectsPublisher searchQuickConnectsPaginator(Consumer<SearchQuickConnectsRequest.Builder> searchQuickConnectsRequest)

      This is a variant of searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) 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.connect.paginators.SearchQuickConnectsPublisher publisher = client.searchQuickConnectsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchQuickConnectsPublisher publisher = client.searchQuickConnectsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchQuickConnectsResponse 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 searchQuickConnects(software.amazon.awssdk.services.connect.model.SearchQuickConnectsRequest) operation.


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

      Parameters:
      searchQuickConnectsRequest - A Consumer that will call methods on SearchQuickConnectsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourceTags

      default CompletableFuture<SearchResourceTagsResponse> searchResourceTags(SearchResourceTagsRequest searchResourceTagsRequest)

      Searches tags used in an Amazon Connect instance using optional search criteria.

      Parameters:
      searchResourceTagsRequest -
      Returns:
      A Java Future containing the result of the SearchResourceTags 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • MaximumResultReturnedException Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourceTags

      default CompletableFuture<SearchResourceTagsResponse> searchResourceTags(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest)

      Searches tags used in an Amazon Connect instance using optional search criteria.


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

      Parameters:
      searchResourceTagsRequest - A Consumer that will call methods on SearchResourceTagsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchResourceTags 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • MaximumResultReturnedException Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourceTagsPaginator

      default SearchResourceTagsPublisher searchResourceTagsPaginator(SearchResourceTagsRequest searchResourceTagsRequest)

      This is a variant of searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) 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.connect.paginators.SearchResourceTagsPublisher publisher = client.searchResourceTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsPublisher publisher = client.searchResourceTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse 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 searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation.

      Parameters:
      searchResourceTagsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • MaximumResultReturnedException Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchResourceTagsPaginator

      default SearchResourceTagsPublisher searchResourceTagsPaginator(Consumer<SearchResourceTagsRequest.Builder> searchResourceTagsRequest)

      This is a variant of searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) 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.connect.paginators.SearchResourceTagsPublisher publisher = client.searchResourceTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchResourceTagsPublisher publisher = client.searchResourceTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchResourceTagsResponse 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 searchResourceTags(software.amazon.awssdk.services.connect.model.SearchResourceTagsRequest) operation.


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

      Parameters:
      searchResourceTagsRequest - A Consumer that will call methods on SearchResourceTagsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • MaximumResultReturnedException Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRoutingProfiles

      default CompletableFuture<SearchRoutingProfilesResponse> searchRoutingProfiles(SearchRoutingProfilesRequest searchRoutingProfilesRequest)

      Searches routing profiles in an Amazon Connect instance, with optional filtering.

      Parameters:
      searchRoutingProfilesRequest -
      Returns:
      A Java Future containing the result of the SearchRoutingProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRoutingProfiles

      default CompletableFuture<SearchRoutingProfilesResponse> searchRoutingProfiles(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest)

      Searches routing profiles in an Amazon Connect instance, with optional filtering.


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

      Parameters:
      searchRoutingProfilesRequest - A Consumer that will call methods on SearchRoutingProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchRoutingProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRoutingProfilesPaginator

      default SearchRoutingProfilesPublisher searchRoutingProfilesPaginator(SearchRoutingProfilesRequest searchRoutingProfilesRequest)

      This is a variant of searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) 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.connect.paginators.SearchRoutingProfilesPublisher publisher = client.searchRoutingProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesPublisher publisher = client.searchRoutingProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse 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 searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation.

      Parameters:
      searchRoutingProfilesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchRoutingProfilesPaginator

      default SearchRoutingProfilesPublisher searchRoutingProfilesPaginator(Consumer<SearchRoutingProfilesRequest.Builder> searchRoutingProfilesRequest)

      This is a variant of searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) 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.connect.paginators.SearchRoutingProfilesPublisher publisher = client.searchRoutingProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchRoutingProfilesPublisher publisher = client.searchRoutingProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesResponse 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 searchRoutingProfiles(software.amazon.awssdk.services.connect.model.SearchRoutingProfilesRequest) operation.


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

      Parameters:
      searchRoutingProfilesRequest - A Consumer that will call methods on SearchRoutingProfilesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSecurityProfiles

      default CompletableFuture<SearchSecurityProfilesResponse> searchSecurityProfiles(SearchSecurityProfilesRequest searchSecurityProfilesRequest)

      Searches security profiles in an Amazon Connect instance, with optional filtering.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      searchSecurityProfilesRequest -
      Returns:
      A Java Future containing the result of the SearchSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSecurityProfiles

      default CompletableFuture<SearchSecurityProfilesResponse> searchSecurityProfiles(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest)

      Searches security profiles in an Amazon Connect instance, with optional filtering.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      searchSecurityProfilesRequest - A Consumer that will call methods on SearchSecurityProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSecurityProfilesPaginator

      default SearchSecurityProfilesPublisher searchSecurityProfilesPaginator(SearchSecurityProfilesRequest searchSecurityProfilesRequest)

      This is a variant of searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) 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.connect.paginators.SearchSecurityProfilesPublisher publisher = client.searchSecurityProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesPublisher publisher = client.searchSecurityProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse 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 searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation.

      Parameters:
      searchSecurityProfilesRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSecurityProfilesPaginator

      default SearchSecurityProfilesPublisher searchSecurityProfilesPaginator(Consumer<SearchSecurityProfilesRequest.Builder> searchSecurityProfilesRequest)

      This is a variant of searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) 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.connect.paginators.SearchSecurityProfilesPublisher publisher = client.searchSecurityProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchSecurityProfilesPublisher publisher = client.searchSecurityProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesResponse 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 searchSecurityProfiles(software.amazon.awssdk.services.connect.model.SearchSecurityProfilesRequest) operation.


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

      Parameters:
      searchSecurityProfilesRequest - A Consumer that will call methods on SearchSecurityProfilesRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUserHierarchyGroups

      default CompletableFuture<SearchUserHierarchyGroupsResponse> searchUserHierarchyGroups(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest)

      Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

      The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

      Parameters:
      searchUserHierarchyGroupsRequest -
      Returns:
      A Java Future containing the result of the SearchUserHierarchyGroups 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUserHierarchyGroups

      default CompletableFuture<SearchUserHierarchyGroupsResponse> searchUserHierarchyGroups(Consumer<SearchUserHierarchyGroupsRequest.Builder> searchUserHierarchyGroupsRequest)

      Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

      The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.


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

      Parameters:
      searchUserHierarchyGroupsRequest - A Consumer that will call methods on SearchUserHierarchyGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchUserHierarchyGroups 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUserHierarchyGroupsPaginator

      default SearchUserHierarchyGroupsPublisher searchUserHierarchyGroupsPaginator(SearchUserHierarchyGroupsRequest searchUserHierarchyGroupsRequest)

      This is a variant of searchUserHierarchyGroups(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsRequest) 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.connect.paginators.SearchUserHierarchyGroupsPublisher publisher = client.searchUserHierarchyGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchUserHierarchyGroupsPublisher publisher = client.searchUserHierarchyGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsResponse 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 searchUserHierarchyGroups(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsRequest) operation.

      Parameters:
      searchUserHierarchyGroupsRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUserHierarchyGroupsPaginator

      default SearchUserHierarchyGroupsPublisher searchUserHierarchyGroupsPaginator(Consumer<SearchUserHierarchyGroupsRequest.Builder> searchUserHierarchyGroupsRequest)

      This is a variant of searchUserHierarchyGroups(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsRequest) 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.connect.paginators.SearchUserHierarchyGroupsPublisher publisher = client.searchUserHierarchyGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchUserHierarchyGroupsPublisher publisher = client.searchUserHierarchyGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsResponse 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 searchUserHierarchyGroups(software.amazon.awssdk.services.connect.model.SearchUserHierarchyGroupsRequest) operation.


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

      Parameters:
      searchUserHierarchyGroupsRequest - A Consumer that will call methods on SearchUserHierarchyGroupsRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsers

      default CompletableFuture<SearchUsersResponse> searchUsers(SearchUsersRequest searchUsersRequest)

      Searches users in an Amazon Connect instance, with optional filtering.

      AfterContactWorkTimeLimit is returned in milliseconds.

      Parameters:
      searchUsersRequest -
      Returns:
      A Java Future containing the result of the SearchUsers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsers

      default CompletableFuture<SearchUsersResponse> searchUsers(Consumer<SearchUsersRequest.Builder> searchUsersRequest)

      Searches users in an Amazon Connect instance, with optional filtering.

      AfterContactWorkTimeLimit is returned in milliseconds.


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

      Parameters:
      searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchUsers 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsersPaginator

      default SearchUsersPublisher searchUsersPaginator(SearchUsersRequest searchUsersRequest)

      This is a variant of searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) 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.connect.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchUsersResponse 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 searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation.

      Parameters:
      searchUsersRequest -
      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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchUsersPaginator

      default SearchUsersPublisher searchUsersPaginator(Consumer<SearchUsersRequest.Builder> searchUsersRequest)

      This is a variant of searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) 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.connect.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchUsersPublisher publisher = client.searchUsersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchUsersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchUsersResponse 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 searchUsers(software.amazon.awssdk.services.connect.model.SearchUsersRequest) operation.


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

      Parameters:
      searchUsersRequest - A Consumer that will call methods on SearchUsersRequest.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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchVocabularies

      default CompletableFuture<SearchVocabulariesResponse> searchVocabularies(SearchVocabulariesRequest searchVocabulariesRequest)

      Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

      Parameters:
      searchVocabulariesRequest -
      Returns:
      A Java Future containing the result of the SearchVocabularies 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchVocabularies

      default CompletableFuture<SearchVocabulariesResponse> searchVocabularies(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest)

      Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.


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

      Parameters:
      searchVocabulariesRequest - A Consumer that will call methods on SearchVocabulariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchVocabularies 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchVocabulariesPaginator

      default SearchVocabulariesPublisher searchVocabulariesPaginator(SearchVocabulariesRequest searchVocabulariesRequest)

      This is a variant of searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) 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.connect.paginators.SearchVocabulariesPublisher publisher = client.searchVocabulariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesPublisher publisher = client.searchVocabulariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse 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 searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation.

      Parameters:
      searchVocabulariesRequest -
      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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchVocabulariesPaginator

      default SearchVocabulariesPublisher searchVocabulariesPaginator(Consumer<SearchVocabulariesRequest.Builder> searchVocabulariesRequest)

      This is a variant of searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) 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.connect.paginators.SearchVocabulariesPublisher publisher = client.searchVocabulariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.connect.paginators.SearchVocabulariesPublisher publisher = client.searchVocabulariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.connect.model.SearchVocabulariesResponse 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 searchVocabularies(software.amazon.awssdk.services.connect.model.SearchVocabulariesRequest) operation.


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

      Parameters:
      searchVocabulariesRequest - A Consumer that will call methods on SearchVocabulariesRequest.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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendChatIntegrationEvent

      default CompletableFuture<SendChatIntegrationEventResponse> sendChatIntegrationEvent(SendChatIntegrationEventRequest sendChatIntegrationEventRequest)

      Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

      • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

      • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

      When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

      Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.

      Parameters:
      sendChatIntegrationEventRequest -
      Returns:
      A Java Future containing the result of the SendChatIntegrationEvent 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendChatIntegrationEvent

      default CompletableFuture<SendChatIntegrationEventResponse> sendChatIntegrationEvent(Consumer<SendChatIntegrationEventRequest.Builder> sendChatIntegrationEventRequest)

      Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:

      • SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat

      • ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

      When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.

      Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.


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

      Parameters:
      sendChatIntegrationEventRequest - A Consumer that will call methods on SendChatIntegrationEventRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendChatIntegrationEvent 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAttachedFileUpload

      default CompletableFuture<StartAttachedFileUploadResponse> startAttachedFileUpload(StartAttachedFileUploadRequest startAttachedFileUploadRequest)

      Provides a pre-signed Amazon S3 URL in response for uploading your content.

      You may only use this API to upload attachments to an Amazon Connect Case.

      Parameters:
      startAttachedFileUploadRequest -
      Returns:
      A Java Future containing the result of the StartAttachedFileUpload 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startAttachedFileUpload

      default CompletableFuture<StartAttachedFileUploadResponse> startAttachedFileUpload(Consumer<StartAttachedFileUploadRequest.Builder> startAttachedFileUploadRequest)

      Provides a pre-signed Amazon S3 URL in response for uploading your content.

      You may only use this API to upload attachments to an Amazon Connect Case.


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

      Parameters:
      startAttachedFileUploadRequest - A Consumer that will call methods on StartAttachedFileUploadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartAttachedFileUpload 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceConflictException A resource already has that name.
      • ServiceQuotaExceededException The service quota 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startChatContact

      default CompletableFuture<StartChatContactResponse> startChatContact(StartChatContactRequest startChatContactRequest)

      Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

      When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

      A 429 error occurs in the following situations:

      • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

      • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

      If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

      For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

      Parameters:
      startChatContactRequest -
      Returns:
      A Java Future containing the result of the StartChatContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startChatContact

      default CompletableFuture<StartChatContactResponse> startChatContact(Consumer<StartChatContactRequest.Builder> startChatContactRequest)

      Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

      When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

      A 429 error occurs in the following situations:

      • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.

      • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

      If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

      For more information about chat, see the following topics in the Amazon Connect Administrator Guide:


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

      Parameters:
      startChatContactRequest - A Consumer that will call methods on StartChatContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartChatContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactEvaluation

      default CompletableFuture<StartContactEvaluationResponse> startContactEvaluation(StartContactEvaluationRequest startContactEvaluationRequest)

      Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

      Evaluations created through the public API do not contain answer values suggested from automation.

      Parameters:
      startContactEvaluationRequest -
      Returns:
      A Java Future containing the result of the StartContactEvaluation 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactEvaluation

      default CompletableFuture<StartContactEvaluationResponse> startContactEvaluation(Consumer<StartContactEvaluationRequest.Builder> startContactEvaluationRequest)

      Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.

      Evaluations created through the public API do not contain answer values suggested from automation.


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

      Parameters:
      startContactEvaluationRequest - A Consumer that will call methods on StartContactEvaluationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartContactEvaluation 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactRecording

      default CompletableFuture<StartContactRecordingResponse> startContactRecording(StartContactRecordingRequest startContactRecordingRequest)

      Starts recording the contact:

      • If the API is called before the agent joins the call, recording starts when the agent joins the call.

      • If the API is called after the agent joins the call, recording starts at the time of the API call.

      StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

      You can use this API to override the recording behavior configured in the Set recording behavior block.

      Only voice recordings are supported at this time.

      Parameters:
      startContactRecordingRequest -
      Returns:
      A Java Future containing the result of the StartContactRecording 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactRecording

      default CompletableFuture<StartContactRecordingResponse> startContactRecording(Consumer<StartContactRecordingRequest.Builder> startContactRecordingRequest)

      Starts recording the contact:

      • If the API is called before the agent joins the call, recording starts when the agent joins the call.

      • If the API is called after the agent joins the call, recording starts at the time of the API call.

      StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

      You can use this API to override the recording behavior configured in the Set recording behavior block.

      Only voice recordings are supported at this time.


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

      Parameters:
      startContactRecordingRequest - A Consumer that will call methods on StartContactRecordingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartContactRecording 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactStreaming

      default CompletableFuture<StartContactStreamingResponse> startContactStreaming(StartContactStreamingRequest startContactStreamingRequest)

      Initiates real-time message streaming for a new chat contact.

      For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

      For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

      Parameters:
      startContactStreamingRequest -
      Returns:
      A Java Future containing the result of the StartContactStreaming 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContactStreaming

      default CompletableFuture<StartContactStreamingResponse> startContactStreaming(Consumer<StartContactStreamingRequest.Builder> startContactStreamingRequest)

      Initiates real-time message streaming for a new chat contact.

      For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

      For more information about chat, see the following topics in the Amazon Connect Administrator Guide:


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

      Parameters:
      startContactStreamingRequest - A Consumer that will call methods on StartContactStreamingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartContactStreaming 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startOutboundChatContact

      default CompletableFuture<StartOutboundChatContactResponse> startOutboundChatContact(StartOutboundChatContactRequest startOutboundChatContactRequest)

      Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.

      SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.

      This API can be used to initiate outbound SMS contacts for an agent or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

      For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:

      Parameters:
      startOutboundChatContactRequest -
      Returns:
      A Java Future containing the result of the StartOutboundChatContact 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.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startOutboundChatContact

      default CompletableFuture<StartOutboundChatContactResponse> startOutboundChatContact(Consumer<StartOutboundChatContactRequest.Builder> startOutboundChatContactRequest)

      Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.

      SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.

      This API can be used to initiate outbound SMS contacts for an agent or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

      For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:


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

      Parameters:
      startOutboundChatContactRequest - A Consumer that will call methods on StartOutboundChatContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartOutboundChatContact 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.
      • ConflictException Operation cannot be performed at this time as there is a conflict with another operation or contact state.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startOutboundVoiceContact

      default CompletableFuture<StartOutboundVoiceContactResponse> startOutboundVoiceContact(StartOutboundVoiceContactRequest startOutboundVoiceContactRequest)

      Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

      Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

      There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

      UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

      Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

      Parameters:
      startOutboundVoiceContactRequest -
      Returns:
      A Java Future containing the result of the StartOutboundVoiceContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DestinationNotAllowedException Outbound calls to the destination number are not allowed.
      • OutboundContactNotPermittedException The contact is not permitted.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startOutboundVoiceContact

      default CompletableFuture<StartOutboundVoiceContactResponse> startOutboundVoiceContact(Consumer<StartOutboundVoiceContactRequest.Builder> startOutboundVoiceContactRequest)

      Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

      Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

      There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

      UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

      Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.


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

      Parameters:
      startOutboundVoiceContactRequest - A Consumer that will call methods on StartOutboundVoiceContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartOutboundVoiceContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • DestinationNotAllowedException Outbound calls to the destination number are not allowed.
      • OutboundContactNotPermittedException The contact is not permitted.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTaskContact

      default CompletableFuture<StartTaskContactResponse> startTaskContact(StartTaskContactRequest startTaskContactRequest)

      Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

      When using PreviousContactId and RelatedContactId input parameters, note the following:

      • PreviousContactId

        • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

        • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

      • RelatedContactId

        • Copies contact attributes from the related task contact to the new contact.

        • Any update on attributes in a new task contact does not update attributes on previous contact.

        • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

      In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

      A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.

      Parameters:
      startTaskContactRequest -
      Returns:
      A Java Future containing the result of the StartTaskContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTaskContact

      default CompletableFuture<StartTaskContactResponse> startTaskContact(Consumer<StartTaskContactRequest.Builder> startTaskContactRequest)

      Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.

      When using PreviousContactId and RelatedContactId input parameters, note the following:

      • PreviousContactId

        • Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.

        • There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.

      • RelatedContactId

        • Copies contact attributes from the related task contact to the new contact.

        • Any update on attributes in a new task contact does not update attributes on previous contact.

        • There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.

      In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

      A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.


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

      Parameters:
      startTaskContactRequest - A Consumer that will call methods on StartTaskContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTaskContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startWebRTCContact

      default CompletableFuture<StartWebRtcContactResponse> startWebRTCContact(StartWebRtcContactRequest startWebRtcContactRequest)

      Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

      Parameters:
      startWebRtcContactRequest -
      Returns:
      A Java Future containing the result of the StartWebRTCContact 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startWebRTCContact

      default CompletableFuture<StartWebRtcContactResponse> startWebRTCContact(Consumer<StartWebRtcContactRequest.Builder> startWebRtcContactRequest)

      Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).


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

      Parameters:
      startWebRtcContactRequest - A Consumer that will call methods on StartWebRtcContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartWebRTCContact 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.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ResourceNotFoundException The specified resource was 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContact

      default CompletableFuture<StopContactResponse> stopContact(StopContactRequest stopContactRequest)

      Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

      • DISCONNECT

      • TRANSFER

      • QUEUE_TRANSFER

      • EXTERNAL_OUTBOUND

      • MONITOR

      Chat and task contacts can be terminated in any state, regardless of initiation method.

      Parameters:
      stopContactRequest -
      Returns:
      A Java Future containing the result of the StopContact 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.
      • ContactNotFoundException The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContact

      default CompletableFuture<StopContactResponse> stopContact(Consumer<StopContactRequest.Builder> stopContactRequest)

      Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

      • DISCONNECT

      • TRANSFER

      • QUEUE_TRANSFER

      • EXTERNAL_OUTBOUND

      • MONITOR

      Chat and task contacts can be terminated in any state, regardless of initiation method.


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

      Parameters:
      stopContactRequest - A Consumer that will call methods on StopContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopContact 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.
      • ContactNotFoundException The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContactRecording

      default CompletableFuture<StopContactRecordingResponse> stopContactRecording(StopContactRecordingRequest stopContactRecordingRequest)

      Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

      Only voice recordings are supported at this time.

      Parameters:
      stopContactRecordingRequest -
      Returns:
      A Java Future containing the result of the StopContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContactRecording

      default CompletableFuture<StopContactRecordingResponse> stopContactRecording(Consumer<StopContactRecordingRequest.Builder> stopContactRecordingRequest)

      Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

      Only voice recordings are supported at this time.


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

      Parameters:
      stopContactRecordingRequest - A Consumer that will call methods on StopContactRecordingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContactStreaming

      default CompletableFuture<StopContactStreamingResponse> stopContactStreaming(StopContactStreamingRequest stopContactStreamingRequest)

      Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.

      Parameters:
      stopContactStreamingRequest -
      Returns:
      A Java Future containing the result of the StopContactStreaming 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopContactStreaming

      default CompletableFuture<StopContactStreamingResponse> stopContactStreaming(Consumer<StopContactStreamingRequest.Builder> stopContactStreamingRequest)

      Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.


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

      Parameters:
      stopContactStreamingRequest - A Consumer that will call methods on StopContactStreamingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopContactStreaming 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitContactEvaluation

      default CompletableFuture<SubmitContactEvaluationResponse> submitContactEvaluation(SubmitContactEvaluationRequest submitContactEvaluationRequest)

      Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({} ) to the question identifier.

      If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

      Parameters:
      submitContactEvaluationRequest -
      Returns:
      A Java Future containing the result of the SubmitContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • submitContactEvaluation

      default CompletableFuture<SubmitContactEvaluationResponse> submitContactEvaluation(Consumer<SubmitContactEvaluationRequest.Builder> submitContactEvaluationRequest)

      Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({} ) to the question identifier.

      If a contact evaluation is already in submitted state, this operation will trigger a resubmission.


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

      Parameters:
      submitContactEvaluationRequest - A Consumer that will call methods on SubmitContactEvaluationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • suspendContactRecording

      default CompletableFuture<SuspendContactRecordingResponse> suspendContactRecording(SuspendContactRecordingRequest suspendContactRecordingRequest)

      When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

      The period of time that the recording is suspended is filled with silence in the final recording.

      Voice and screen recordings are supported.

      Parameters:
      suspendContactRecordingRequest -
      Returns:
      A Java Future containing the result of the SuspendContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • suspendContactRecording

      default CompletableFuture<SuspendContactRecordingResponse> suspendContactRecording(Consumer<SuspendContactRecordingRequest.Builder> suspendContactRecordingRequest)

      When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

      The period of time that the recording is suspended is filled with silence in the final recording.

      Voice and screen recordings are supported.


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

      Parameters:
      suspendContactRecordingRequest - A Consumer that will call methods on SuspendContactRecordingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SuspendContactRecording 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagContact

      default CompletableFuture<TagContactResponse> tagContact(TagContactRequest tagContactRequest)

      Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

      Parameters:
      tagContactRequest -
      Returns:
      A Java Future containing the result of the TagContact 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagContact

      default CompletableFuture<TagContactResponse> tagContact(Consumer<TagContactRequest.Builder> tagContactRequest)

      Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.


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

      Parameters:
      tagContactRequest - A Consumer that will call methods on TagContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagContact 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Adds the specified tags to the specified resource.

      Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

      For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException 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)

      Adds the specified tags to the specified resource.

      Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect.

      For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.


      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:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • transferContact

      default CompletableFuture<TransferContactResponse> transferContact(TransferContactRequest transferContactRequest)

      Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

      Note the following requirements:

      • Transfer is supported for only TASK contacts.

      • Do not use both QueueId and UserId in the same call.

      • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

      • The TransferContact API can be called only on active contacts.

      • A contact cannot be transferred more than 11 times.

      Parameters:
      transferContactRequest -
      Returns:
      A Java Future containing the result of the TransferContact 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.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • transferContact

      default CompletableFuture<TransferContactResponse> transferContact(Consumer<TransferContactRequest.Builder> transferContactRequest)

      Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

      Note the following requirements:

      • Transfer is supported for only TASK contacts.

      • Do not use both QueueId and UserId in the same call.

      • The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.

      • The TransferContact API can be called only on active contacts.

      • A contact cannot be transferred more than 11 times.


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

      Parameters:
      transferContactRequest - A Consumer that will call methods on TransferContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TransferContact 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.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagContact

      default CompletableFuture<UntagContactResponse> untagContact(UntagContactRequest untagContactRequest)

      Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.

      Parameters:
      untagContactRequest -
      Returns:
      A Java Future containing the result of the UntagContact 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagContact

      default CompletableFuture<UntagContactResponse> untagContact(Consumer<UntagContactRequest.Builder> untagContactRequest)

      Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.


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

      Parameters:
      untagContactRequest - A Consumer that will call methods on UntagContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagContact 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException 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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException 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.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:
      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 invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceNotFoundException The specified resource was not found.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentStatus

      default CompletableFuture<UpdateAgentStatusResponse> updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates agent status.

      Parameters:
      updateAgentStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentStatus

      default CompletableFuture<UpdateAgentStatusResponse> updateAgentStatus(Consumer<UpdateAgentStatusRequest.Builder> updateAgentStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates agent status.


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

      Parameters:
      updateAgentStatusRequest - A Consumer that will call methods on UpdateAgentStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgentStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAuthenticationProfile

      default CompletableFuture<UpdateAuthenticationProfileResponse> updateAuthenticationProfile(UpdateAuthenticationProfileRequest updateAuthenticationProfileRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Updates the selected authentication profile.

      Parameters:
      updateAuthenticationProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateAuthenticationProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAuthenticationProfile

      default CompletableFuture<UpdateAuthenticationProfileResponse> updateAuthenticationProfile(Consumer<UpdateAuthenticationProfileRequest.Builder> updateAuthenticationProfileRequest)

      This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

      Updates the selected authentication profile.


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

      Parameters:
      updateAuthenticationProfileRequest - A Consumer that will call methods on UpdateAuthenticationProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAuthenticationProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContact

      default CompletableFuture<UpdateContactResponse> updateContact(UpdateContactRequest updateContactRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

      You can add or update user-defined contact information for both ongoing and completed contacts.

      Parameters:
      updateContactRequest -
      Returns:
      A Java Future containing the result of the UpdateContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContact

      default CompletableFuture<UpdateContactResponse> updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

      You can add or update user-defined contact information for both ongoing and completed contacts.


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

      Parameters:
      updateContactRequest - A Consumer that will call methods on UpdateContactRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContact 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactAttributes

      default CompletableFuture<UpdateContactAttributesResponse> updateContactAttributes(UpdateContactAttributesRequest updateContactAttributesRequest)

      Creates or updates user-defined contact attributes associated with the specified contact.

      You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

      Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.

      Parameters:
      updateContactAttributesRequest -
      Returns:
      A Java Future containing the result of the UpdateContactAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactAttributes

      default CompletableFuture<UpdateContactAttributesResponse> updateContactAttributes(Consumer<UpdateContactAttributesRequest.Builder> updateContactAttributesRequest)

      Creates or updates user-defined contact attributes associated with the specified contact.

      You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

      Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.


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

      Parameters:
      updateContactAttributesRequest - A Consumer that will call methods on UpdateContactAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactAttributes 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactEvaluation

      default CompletableFuture<UpdateContactEvaluationResponse> updateContactEvaluation(UpdateContactEvaluationRequest updateContactEvaluationRequest)

      Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

      Parameters:
      updateContactEvaluationRequest -
      Returns:
      A Java Future containing the result of the UpdateContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactEvaluation

      default CompletableFuture<UpdateContactEvaluationResponse> updateContactEvaluation(Consumer<UpdateContactEvaluationRequest.Builder> updateContactEvaluationRequest)

      Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.


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

      Parameters:
      updateContactEvaluationRequest - A Consumer that will call methods on UpdateContactEvaluationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactEvaluation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowContent

      default CompletableFuture<UpdateContactFlowContentResponse> updateContactFlowContent(UpdateContactFlowContentRequest updateContactFlowContentRequest)

      Updates the specified flow.

      You can also create and update flows using the Amazon Connect Flow language.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.

      Parameters:
      updateContactFlowContentRequest -
      Returns:
      A Java Future containing the result of the UpdateContactFlowContent 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.
      • InvalidContactFlowException The flow is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowContent

      default CompletableFuture<UpdateContactFlowContentResponse> updateContactFlowContent(Consumer<UpdateContactFlowContentRequest.Builder> updateContactFlowContentRequest)

      Updates the specified flow.

      You can also create and update flows using the Amazon Connect Flow language.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.


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

      Parameters:
      updateContactFlowContentRequest - A Consumer that will call methods on UpdateContactFlowContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactFlowContent 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.
      • InvalidContactFlowException The flow is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowMetadata

      default CompletableFuture<UpdateContactFlowMetadataResponse> updateContactFlowMetadata(UpdateContactFlowMetadataRequest updateContactFlowMetadataRequest)

      Updates metadata about specified flow.

      Parameters:
      updateContactFlowMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateContactFlowMetadata 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowMetadata

      default CompletableFuture<UpdateContactFlowMetadataResponse> updateContactFlowMetadata(Consumer<UpdateContactFlowMetadataRequest.Builder> updateContactFlowMetadataRequest)

      Updates metadata about specified flow.


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

      Parameters:
      updateContactFlowMetadataRequest - A Consumer that will call methods on UpdateContactFlowMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactFlowMetadata 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowModuleContent

      default CompletableFuture<UpdateContactFlowModuleContentResponse> updateContactFlowModuleContent(UpdateContactFlowModuleContentRequest updateContactFlowModuleContentRequest)

      Updates specified flow module for the specified Amazon Connect instance.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.

      Parameters:
      updateContactFlowModuleContentRequest -
      Returns:
      A Java Future containing the result of the UpdateContactFlowModuleContent 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidContactFlowModuleException The problems with the module. Please fix before trying again.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowModuleContent

      default CompletableFuture<UpdateContactFlowModuleContentResponse> updateContactFlowModuleContent(Consumer<UpdateContactFlowModuleContentRequest.Builder> updateContactFlowModuleContentRequest)

      Updates specified flow module for the specified Amazon Connect instance.

      Use the invalid input: '&#36'SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:invalid input: '&#36'SAVED. Once a contact flow is published, invalid input: '&#36'SAVED needs to be supplied to view saved content that has not been published.


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

      Parameters:
      updateContactFlowModuleContentRequest - A Consumer that will call methods on UpdateContactFlowModuleContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactFlowModuleContent 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidContactFlowModuleException The problems with the module. Please fix before trying again.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowModuleMetadata

      default CompletableFuture<UpdateContactFlowModuleMetadataResponse> updateContactFlowModuleMetadata(UpdateContactFlowModuleMetadataRequest updateContactFlowModuleMetadataRequest)

      Updates metadata about specified flow module.

      Parameters:
      updateContactFlowModuleMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateContactFlowModuleMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowModuleMetadata

      default CompletableFuture<UpdateContactFlowModuleMetadataResponse> updateContactFlowModuleMetadata(Consumer<UpdateContactFlowModuleMetadataRequest.Builder> updateContactFlowModuleMetadataRequest)

      Updates metadata about specified flow module.


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

      Parameters:
      updateContactFlowModuleMetadataRequest - A Consumer that will call methods on UpdateContactFlowModuleMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactFlowModuleMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowName

      default CompletableFuture<UpdateContactFlowNameResponse> updateContactFlowName(UpdateContactFlowNameRequest updateContactFlowNameRequest)

      The name of the flow.

      You can also create and update flows using the Amazon Connect Flow language.

      Parameters:
      updateContactFlowNameRequest -
      Returns:
      A Java Future containing the result of the UpdateContactFlowName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactFlowName

      default CompletableFuture<UpdateContactFlowNameResponse> updateContactFlowName(Consumer<UpdateContactFlowNameRequest.Builder> updateContactFlowNameRequest)

      The name of the flow.

      You can also create and update flows using the Amazon Connect Flow language.


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

      Parameters:
      updateContactFlowNameRequest - A Consumer that will call methods on UpdateContactFlowNameRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactFlowName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactRoutingData

      default CompletableFuture<UpdateContactRoutingDataResponse> updateContactRoutingData(UpdateContactRoutingDataRequest updateContactRoutingDataRequest)

      Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

      Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.

      Parameters:
      updateContactRoutingDataRequest -
      Returns:
      A Java Future containing the result of the UpdateContactRoutingData 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.
      • ResourceConflictException A resource already has that name.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactRoutingData

      default CompletableFuture<UpdateContactRoutingDataResponse> updateContactRoutingData(Consumer<UpdateContactRoutingDataRequest.Builder> updateContactRoutingDataRequest)

      Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.

      Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.


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

      Parameters:
      updateContactRoutingDataRequest - A Consumer that will call methods on UpdateContactRoutingDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactRoutingData 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.
      • ResourceConflictException A resource already has that name.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactSchedule

      default CompletableFuture<UpdateContactScheduleResponse> updateContactSchedule(UpdateContactScheduleRequest updateContactScheduleRequest)

      Updates the scheduled time of a task contact that is already scheduled.

      Parameters:
      updateContactScheduleRequest -
      Returns:
      A Java Future containing the result of the UpdateContactSchedule 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContactSchedule

      default CompletableFuture<UpdateContactScheduleResponse> updateContactSchedule(Consumer<UpdateContactScheduleRequest.Builder> updateContactScheduleRequest)

      Updates the scheduled time of a task contact that is already scheduled.


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

      Parameters:
      updateContactScheduleRequest - A Consumer that will call methods on UpdateContactScheduleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContactSchedule 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • LimitExceededException The allowed limit for the resource has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEvaluationForm

      default CompletableFuture<UpdateEvaluationFormResponse> updateEvaluationForm(UpdateEvaluationFormRequest updateEvaluationFormRequest)

      Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

      This operation does not support partial updates. Instead it does a full update of evaluation form content.

      Parameters:
      updateEvaluationFormRequest -
      Returns:
      A Java Future containing the result of the UpdateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateEvaluationForm

      default CompletableFuture<UpdateEvaluationFormResponse> updateEvaluationForm(Consumer<UpdateEvaluationFormRequest.Builder> updateEvaluationFormRequest)

      Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

      This operation does not support partial updates. Instead it does a full update of evaluation form content.


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

      Parameters:
      updateEvaluationFormRequest - A Consumer that will call methods on UpdateEvaluationFormRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateEvaluationForm 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHoursOfOperation

      default CompletableFuture<UpdateHoursOfOperationResponse> updateHoursOfOperation(UpdateHoursOfOperationRequest updateHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the hours of operation.

      Parameters:
      updateHoursOfOperationRequest -
      Returns:
      A Java Future containing the result of the UpdateHoursOfOperation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateHoursOfOperation

      default CompletableFuture<UpdateHoursOfOperationResponse> updateHoursOfOperation(Consumer<UpdateHoursOfOperationRequest.Builder> updateHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the hours of operation.


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

      Parameters:
      updateHoursOfOperationRequest - A Consumer that will call methods on UpdateHoursOfOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateHoursOfOperation 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceAttribute

      default CompletableFuture<UpdateInstanceAttributeResponse> updateInstanceAttribute(UpdateInstanceAttributeRequest updateInstanceAttributeRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the value for the specified attribute type.

      Parameters:
      updateInstanceAttributeRequest -
      Returns:
      A Java Future containing the result of the UpdateInstanceAttribute 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceAttribute

      default CompletableFuture<UpdateInstanceAttributeResponse> updateInstanceAttribute(Consumer<UpdateInstanceAttributeRequest.Builder> updateInstanceAttributeRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the value for the specified attribute type.


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

      Parameters:
      updateInstanceAttributeRequest - A Consumer that will call methods on UpdateInstanceAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInstanceAttribute 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceStorageConfig

      default CompletableFuture<UpdateInstanceStorageConfigResponse> updateInstanceStorageConfig(UpdateInstanceStorageConfigRequest updateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates an existing configuration for a resource type. This API is idempotent.

      Parameters:
      updateInstanceStorageConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceStorageConfig

      default CompletableFuture<UpdateInstanceStorageConfigResponse> updateInstanceStorageConfig(Consumer<UpdateInstanceStorageConfigRequest.Builder> updateInstanceStorageConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates an existing configuration for a resource type. This API is idempotent.


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

      Parameters:
      updateInstanceStorageConfigRequest - A Consumer that will call methods on UpdateInstanceStorageConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInstanceStorageConfig 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateParticipantRoleConfig

      default CompletableFuture<UpdateParticipantRoleConfigResponse> updateParticipantRoleConfig(UpdateParticipantRoleConfigRequest updateParticipantRoleConfigRequest)

      Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

      • Customer idle timeout

      • Customer auto-disconnect timeout

      • Agent idle timeout

      • Agent auto-disconnect timeout

      For more information about how chat timeouts work, see Set up chat timeouts for human participants.

      Parameters:
      updateParticipantRoleConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateParticipantRoleConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateParticipantRoleConfig

      default CompletableFuture<UpdateParticipantRoleConfigResponse> updateParticipantRoleConfig(Consumer<UpdateParticipantRoleConfigRequest.Builder> updateParticipantRoleConfigRequest)

      Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:

      • Customer idle timeout

      • Customer auto-disconnect timeout

      • Agent idle timeout

      • Agent auto-disconnect timeout

      For more information about how chat timeouts work, see Set up chat timeouts for human participants.


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

      Parameters:
      updateParticipantRoleConfigRequest - A Consumer that will call methods on UpdateParticipantRoleConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateParticipantRoleConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumber

      default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(UpdatePhoneNumberRequest updatePhoneNumberRequest)

      Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

      After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

      You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

      Parameters:
      updatePhoneNumberRequest -
      Returns:
      A Java Future containing the result of the UpdatePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumber

      default CompletableFuture<UpdatePhoneNumberResponse> updatePhoneNumber(Consumer<UpdatePhoneNumberRequest.Builder> updatePhoneNumberRequest)

      Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

      After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

      You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.


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

      Parameters:
      updatePhoneNumberRequest - A Consumer that will call methods on UpdatePhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePhoneNumber 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumberMetadata

      default CompletableFuture<UpdatePhoneNumberMetadataResponse> updatePhoneNumberMetadata(UpdatePhoneNumberMetadataRequest updatePhoneNumberMetadataRequest)

      Updates a phone number’s metadata.

      To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

      Parameters:
      updatePhoneNumberMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdatePhoneNumberMetadata 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePhoneNumberMetadata

      default CompletableFuture<UpdatePhoneNumberMetadataResponse> updatePhoneNumberMetadata(Consumer<UpdatePhoneNumberMetadataRequest.Builder> updatePhoneNumberMetadataRequest)

      Updates a phone number’s metadata.

      To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.


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

      Parameters:
      updatePhoneNumberMetadataRequest - A Consumer that will call methods on UpdatePhoneNumberMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePhoneNumberMetadata 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • InvalidRequestException The request is not valid.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • IdempotencyException An entity with the same name already exists.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePredefinedAttribute

      default CompletableFuture<UpdatePredefinedAttributeResponse> updatePredefinedAttribute(UpdatePredefinedAttributeRequest updatePredefinedAttributeRequest)

      Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.

      Parameters:
      updatePredefinedAttributeRequest -
      Returns:
      A Java Future containing the result of the UpdatePredefinedAttribute 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePredefinedAttribute

      default CompletableFuture<UpdatePredefinedAttributeResponse> updatePredefinedAttribute(Consumer<UpdatePredefinedAttributeRequest.Builder> updatePredefinedAttributeRequest)

      Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.


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

      Parameters:
      updatePredefinedAttributeRequest - A Consumer that will call methods on UpdatePredefinedAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePredefinedAttribute 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePrompt

      default CompletableFuture<UpdatePromptResponse> updatePrompt(UpdatePromptRequest updatePromptRequest)

      Updates a prompt.

      Parameters:
      updatePromptRequest -
      Returns:
      A Java Future containing the result of the UpdatePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updatePrompt

      default CompletableFuture<UpdatePromptResponse> updatePrompt(Consumer<UpdatePromptRequest.Builder> updatePromptRequest)

      Updates a prompt.


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

      Parameters:
      updatePromptRequest - A Consumer that will call methods on UpdatePromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdatePrompt 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueHoursOfOperation

      default CompletableFuture<UpdateQueueHoursOfOperationResponse> updateQueueHoursOfOperation(UpdateQueueHoursOfOperationRequest updateQueueHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the hours of operation for the specified queue.

      Parameters:
      updateQueueHoursOfOperationRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueHoursOfOperation

      default CompletableFuture<UpdateQueueHoursOfOperationResponse> updateQueueHoursOfOperation(Consumer<UpdateQueueHoursOfOperationRequest.Builder> updateQueueHoursOfOperationRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the hours of operation for the specified queue.


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

      Parameters:
      updateQueueHoursOfOperationRequest - A Consumer that will call methods on UpdateQueueHoursOfOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueHoursOfOperation 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueMaxContacts

      default CompletableFuture<UpdateQueueMaxContactsResponse> updateQueueMaxContacts(UpdateQueueMaxContactsRequest updateQueueMaxContactsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the maximum number of contacts allowed in a queue before it is considered full.

      Parameters:
      updateQueueMaxContactsRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueMaxContacts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueMaxContacts

      default CompletableFuture<UpdateQueueMaxContactsResponse> updateQueueMaxContacts(Consumer<UpdateQueueMaxContactsRequest.Builder> updateQueueMaxContactsRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the maximum number of contacts allowed in a queue before it is considered full.


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

      Parameters:
      updateQueueMaxContactsRequest - A Consumer that will call methods on UpdateQueueMaxContactsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueMaxContacts 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueName

      default CompletableFuture<UpdateQueueNameResponse> updateQueueName(UpdateQueueNameRequest updateQueueNameRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the name and description of a queue. At least Name or Description must be provided.

      Parameters:
      updateQueueNameRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueName 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueName

      default CompletableFuture<UpdateQueueNameResponse> updateQueueName(Consumer<UpdateQueueNameRequest.Builder> updateQueueNameRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the name and description of a queue. At least Name or Description must be provided.


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

      Parameters:
      updateQueueNameRequest - A Consumer that will call methods on UpdateQueueNameRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueName 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueOutboundCallerConfig

      default CompletableFuture<UpdateQueueOutboundCallerConfigResponse> updateQueueOutboundCallerConfig(UpdateQueueOutboundCallerConfigRequest updateQueueOutboundCallerConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

      • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

      • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

      Parameters:
      updateQueueOutboundCallerConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueOutboundCallerConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueOutboundCallerConfig

      default CompletableFuture<UpdateQueueOutboundCallerConfigResponse> updateQueueOutboundCallerConfig(Consumer<UpdateQueueOutboundCallerConfigRequest.Builder> updateQueueOutboundCallerConfigRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

      • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

      • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

      • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.


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

      Parameters:
      updateQueueOutboundCallerConfigRequest - A Consumer that will call methods on UpdateQueueOutboundCallerConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueOutboundCallerConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueStatus

      default CompletableFuture<UpdateQueueStatusResponse> updateQueueStatus(UpdateQueueStatusRequest updateQueueStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the status of the queue.

      Parameters:
      updateQueueStatusRequest -
      Returns:
      A Java Future containing the result of the UpdateQueueStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQueueStatus

      default CompletableFuture<UpdateQueueStatusResponse> updateQueueStatus(Consumer<UpdateQueueStatusRequest.Builder> updateQueueStatusRequest)

      This API is in preview release for Amazon Connect and is subject to change.

      Updates the status of the queue.


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

      Parameters:
      updateQueueStatusRequest - A Consumer that will call methods on UpdateQueueStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQueueStatus 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickConnectConfig

      default CompletableFuture<UpdateQuickConnectConfigResponse> updateQuickConnectConfig(UpdateQuickConnectConfigRequest updateQuickConnectConfigRequest)

      Updates the configuration settings for the specified quick connect.

      Parameters:
      updateQuickConnectConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateQuickConnectConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickConnectConfig

      default CompletableFuture<UpdateQuickConnectConfigResponse> updateQuickConnectConfig(Consumer<UpdateQuickConnectConfigRequest.Builder> updateQuickConnectConfigRequest)

      Updates the configuration settings for the specified quick connect.


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

      Parameters:
      updateQuickConnectConfigRequest - A Consumer that will call methods on UpdateQuickConnectConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQuickConnectConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickConnectName

      default CompletableFuture<UpdateQuickConnectNameResponse> updateQuickConnectName(UpdateQuickConnectNameRequest updateQuickConnectNameRequest)

      Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

      Parameters:
      updateQuickConnectNameRequest -
      Returns:
      A Java Future containing the result of the UpdateQuickConnectName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickConnectName

      default CompletableFuture<UpdateQuickConnectNameResponse> updateQuickConnectName(Consumer<UpdateQuickConnectNameRequest.Builder> updateQuickConnectNameRequest)

      Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.


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

      Parameters:
      updateQuickConnectNameRequest - A Consumer that will call methods on UpdateQuickConnectNameRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQuickConnectName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileAgentAvailabilityTimer

      default CompletableFuture<UpdateRoutingProfileAgentAvailabilityTimerResponse> updateRoutingProfileAgentAvailabilityTimer(UpdateRoutingProfileAgentAvailabilityTimerRequest updateRoutingProfileAgentAvailabilityTimerRequest)

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

      Parameters:
      updateRoutingProfileAgentAvailabilityTimerRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileAgentAvailabilityTimer 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileAgentAvailabilityTimer

      default CompletableFuture<UpdateRoutingProfileAgentAvailabilityTimerResponse> updateRoutingProfileAgentAvailabilityTimer(Consumer<UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder> updateRoutingProfileAgentAvailabilityTimerRequest)

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.


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

      Parameters:
      updateRoutingProfileAgentAvailabilityTimerRequest - A Consumer that will call methods on UpdateRoutingProfileAgentAvailabilityTimerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileAgentAvailabilityTimer 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileConcurrency

      default CompletableFuture<UpdateRoutingProfileConcurrencyResponse> updateRoutingProfileConcurrency(UpdateRoutingProfileConcurrencyRequest updateRoutingProfileConcurrencyRequest)

      Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

      Parameters:
      updateRoutingProfileConcurrencyRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileConcurrency 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileConcurrency

      default CompletableFuture<UpdateRoutingProfileConcurrencyResponse> updateRoutingProfileConcurrency(Consumer<UpdateRoutingProfileConcurrencyRequest.Builder> updateRoutingProfileConcurrencyRequest)

      Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.


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

      Parameters:
      updateRoutingProfileConcurrencyRequest - A Consumer that will call methods on UpdateRoutingProfileConcurrencyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileConcurrency 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileDefaultOutboundQueue

      default CompletableFuture<UpdateRoutingProfileDefaultOutboundQueueResponse> updateRoutingProfileDefaultOutboundQueue(UpdateRoutingProfileDefaultOutboundQueueRequest updateRoutingProfileDefaultOutboundQueueRequest)

      Updates the default outbound queue of a routing profile.

      Parameters:
      updateRoutingProfileDefaultOutboundQueueRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileDefaultOutboundQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileDefaultOutboundQueue

      default CompletableFuture<UpdateRoutingProfileDefaultOutboundQueueResponse> updateRoutingProfileDefaultOutboundQueue(Consumer<UpdateRoutingProfileDefaultOutboundQueueRequest.Builder> updateRoutingProfileDefaultOutboundQueueRequest)

      Updates the default outbound queue of a routing profile.


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

      Parameters:
      updateRoutingProfileDefaultOutboundQueueRequest - A Consumer that will call methods on UpdateRoutingProfileDefaultOutboundQueueRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileDefaultOutboundQueue 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileName

      default CompletableFuture<UpdateRoutingProfileNameResponse> updateRoutingProfileName(UpdateRoutingProfileNameRequest updateRoutingProfileNameRequest)

      Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

      Parameters:
      updateRoutingProfileNameRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileName 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileName

      default CompletableFuture<UpdateRoutingProfileNameResponse> updateRoutingProfileName(Consumer<UpdateRoutingProfileNameRequest.Builder> updateRoutingProfileNameRequest)

      Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.


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

      Parameters:
      updateRoutingProfileNameRequest - A Consumer that will call methods on UpdateRoutingProfileNameRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileName 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.
      • DuplicateResourceException A resource with the specified name already exists.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileQueues

      default CompletableFuture<UpdateRoutingProfileQueuesResponse> updateRoutingProfileQueues(UpdateRoutingProfileQueuesRequest updateRoutingProfileQueuesRequest)

      Updates the properties associated with a set of queues for a routing profile.

      Parameters:
      updateRoutingProfileQueuesRequest -
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRoutingProfileQueues

      default CompletableFuture<UpdateRoutingProfileQueuesResponse> updateRoutingProfileQueues(Consumer<UpdateRoutingProfileQueuesRequest.Builder> updateRoutingProfileQueuesRequest)

      Updates the properties associated with a set of queues for a routing profile.


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

      Parameters:
      updateRoutingProfileQueuesRequest - A Consumer that will call methods on UpdateRoutingProfileQueuesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRoutingProfileQueues 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRule

      default CompletableFuture<UpdateRuleResponse> updateRule(UpdateRuleRequest updateRuleRequest)

      Updates a rule for the specified Amazon Connect instance.

      Use the Rules Function language to code conditions for the rule.

      Parameters:
      updateRuleRequest -
      Returns:
      A Java Future containing the result of the UpdateRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRule

      default CompletableFuture<UpdateRuleResponse> updateRule(Consumer<UpdateRuleRequest.Builder> updateRuleRequest)

      Updates a rule for the specified Amazon Connect instance.

      Use the Rules Function language to code conditions for the rule.


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

      Parameters:
      updateRuleRequest - A Consumer that will call methods on UpdateRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRule 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.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • ThrottlingException The throttling limit has been exceeded.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • ResourceConflictException A resource already has that name.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityProfile

      default CompletableFuture<UpdateSecurityProfileResponse> updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)

      Updates a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

      Parameters:
      updateSecurityProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSecurityProfile

      default CompletableFuture<UpdateSecurityProfileResponse> updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest)

      Updates a security profile.

      For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.


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

      Parameters:
      updateSecurityProfileRequest - A Consumer that will call methods on UpdateSecurityProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSecurityProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTaskTemplate

      default CompletableFuture<UpdateTaskTemplateResponse> updateTaskTemplate(UpdateTaskTemplateRequest updateTaskTemplateRequest)

      Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

      Parameters:
      updateTaskTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateTaskTemplate 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.
      • PropertyValidationException The property is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTaskTemplate

      default CompletableFuture<UpdateTaskTemplateResponse> updateTaskTemplate(Consumer<UpdateTaskTemplateRequest.Builder> updateTaskTemplateRequest)

      Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.


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

      Parameters:
      updateTaskTemplateRequest - A Consumer that will call methods on UpdateTaskTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTaskTemplate 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.
      • PropertyValidationException The property is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • ServiceQuotaExceededException The service quota has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrafficDistribution

      default CompletableFuture<UpdateTrafficDistributionResponse> updateTrafficDistribution(UpdateTrafficDistributionRequest updateTrafficDistributionRequest)

      Updates the traffic distribution for a given traffic distribution group.

      The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

      For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.

      Parameters:
      updateTrafficDistributionRequest -
      Returns:
      A Java Future containing the result of the UpdateTrafficDistribution 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTrafficDistribution

      default CompletableFuture<UpdateTrafficDistributionResponse> updateTrafficDistribution(Consumer<UpdateTrafficDistributionRequest.Builder> updateTrafficDistributionRequest)

      Updates the traffic distribution for a given traffic distribution group.

      The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

      For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions in the Amazon Connect Administrator Guide.


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

      Parameters:
      updateTrafficDistributionRequest - A Consumer that will call methods on UpdateTrafficDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTrafficDistribution 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 permissions to perform this action.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceConflictException A resource already has that name.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchy

      default CompletableFuture<UpdateUserHierarchyResponse> updateUserHierarchy(UpdateUserHierarchyRequest updateUserHierarchyRequest)

      Assigns the specified hierarchy group to the specified user.

      Parameters:
      updateUserHierarchyRequest -
      Returns:
      A Java Future containing the result of the UpdateUserHierarchy 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchy

      default CompletableFuture<UpdateUserHierarchyResponse> updateUserHierarchy(Consumer<UpdateUserHierarchyRequest.Builder> updateUserHierarchyRequest)

      Assigns the specified hierarchy group to the specified user.


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

      Parameters:
      updateUserHierarchyRequest - A Consumer that will call methods on UpdateUserHierarchyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserHierarchy 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchyGroupName

      default CompletableFuture<UpdateUserHierarchyGroupNameResponse> updateUserHierarchyGroupName(UpdateUserHierarchyGroupNameRequest updateUserHierarchyGroupNameRequest)

      Updates the name of the user hierarchy group.

      Parameters:
      updateUserHierarchyGroupNameRequest -
      Returns:
      A Java Future containing the result of the UpdateUserHierarchyGroupName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchyGroupName

      default CompletableFuture<UpdateUserHierarchyGroupNameResponse> updateUserHierarchyGroupName(Consumer<UpdateUserHierarchyGroupNameRequest.Builder> updateUserHierarchyGroupNameRequest)

      Updates the name of the user hierarchy group.


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

      Parameters:
      updateUserHierarchyGroupNameRequest - A Consumer that will call methods on UpdateUserHierarchyGroupNameRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserHierarchyGroupName 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchyStructure

      default CompletableFuture<UpdateUserHierarchyStructureResponse> updateUserHierarchyStructure(UpdateUserHierarchyStructureRequest updateUserHierarchyStructureRequest)

      Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

      Parameters:
      updateUserHierarchyStructureRequest -
      Returns:
      A Java Future containing the result of the UpdateUserHierarchyStructure 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserHierarchyStructure

      default CompletableFuture<UpdateUserHierarchyStructureResponse> updateUserHierarchyStructure(Consumer<UpdateUserHierarchyStructureRequest.Builder> updateUserHierarchyStructureRequest)

      Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.


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

      Parameters:
      updateUserHierarchyStructureRequest - A Consumer that will call methods on UpdateUserHierarchyStructureRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserHierarchyStructure 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ResourceInUseException That resource is already in use. Please try another.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserIdentityInfo

      default CompletableFuture<UpdateUserIdentityInfoResponse> updateUserIdentityInfo(UpdateUserIdentityInfoRequest updateUserIdentityInfoRequest)

      Updates the identity information for the specified user.

      We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

      Parameters:
      updateUserIdentityInfoRequest -
      Returns:
      A Java Future containing the result of the UpdateUserIdentityInfo 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserIdentityInfo

      default CompletableFuture<UpdateUserIdentityInfoResponse> updateUserIdentityInfo(Consumer<UpdateUserIdentityInfoRequest.Builder> updateUserIdentityInfoRequest)

      Updates the identity information for the specified user.

      We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.


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

      Parameters:
      updateUserIdentityInfoRequest - A Consumer that will call methods on UpdateUserIdentityInfoRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserIdentityInfo 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserPhoneConfig

      default CompletableFuture<UpdateUserPhoneConfigResponse> updateUserPhoneConfig(UpdateUserPhoneConfigRequest updateUserPhoneConfigRequest)

      Updates the phone configuration settings for the specified user.

      Parameters:
      updateUserPhoneConfigRequest -
      Returns:
      A Java Future containing the result of the UpdateUserPhoneConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserPhoneConfig

      default CompletableFuture<UpdateUserPhoneConfigResponse> updateUserPhoneConfig(Consumer<UpdateUserPhoneConfigRequest.Builder> updateUserPhoneConfigRequest)

      Updates the phone configuration settings for the specified user.


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

      Parameters:
      updateUserPhoneConfigRequest - A Consumer that will call methods on UpdateUserPhoneConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserPhoneConfig 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserProficiencies

      default CompletableFuture<UpdateUserProficienciesResponse> updateUserProficiencies(UpdateUserProficienciesRequest updateUserProficienciesRequest)

      Updates the properties associated with the proficiencies of a user.

      Parameters:
      updateUserProficienciesRequest -
      Returns:
      A Java Future containing the result of the UpdateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserProficiencies

      default CompletableFuture<UpdateUserProficienciesResponse> updateUserProficiencies(Consumer<UpdateUserProficienciesRequest.Builder> updateUserProficienciesRequest)

      Updates the properties associated with the proficiencies of a user.


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

      Parameters:
      updateUserProficienciesRequest - A Consumer that will call methods on UpdateUserProficienciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserProficiencies 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserRoutingProfile

      default CompletableFuture<UpdateUserRoutingProfileResponse> updateUserRoutingProfile(UpdateUserRoutingProfileRequest updateUserRoutingProfileRequest)

      Assigns the specified routing profile to the specified user.

      Parameters:
      updateUserRoutingProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateUserRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserRoutingProfile

      default CompletableFuture<UpdateUserRoutingProfileResponse> updateUserRoutingProfile(Consumer<UpdateUserRoutingProfileRequest.Builder> updateUserRoutingProfileRequest)

      Assigns the specified routing profile to the specified user.


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

      Parameters:
      updateUserRoutingProfileRequest - A Consumer that will call methods on UpdateUserRoutingProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserRoutingProfile 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserSecurityProfiles

      default CompletableFuture<UpdateUserSecurityProfilesResponse> updateUserSecurityProfiles(UpdateUserSecurityProfilesRequest updateUserSecurityProfilesRequest)

      Assigns the specified security profiles to the specified user.

      Parameters:
      updateUserSecurityProfilesRequest -
      Returns:
      A Java Future containing the result of the UpdateUserSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateUserSecurityProfiles

      default CompletableFuture<UpdateUserSecurityProfilesResponse> updateUserSecurityProfiles(Consumer<UpdateUserSecurityProfilesRequest.Builder> updateUserSecurityProfilesRequest)

      Assigns the specified security profiles to the specified user.


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

      Parameters:
      updateUserSecurityProfilesRequest - A Consumer that will call methods on UpdateUserSecurityProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateUserSecurityProfiles 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.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • ThrottlingException The throttling limit has been exceeded.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateViewContent

      default CompletableFuture<UpdateViewContentResponse> updateViewContent(UpdateViewContentRequest updateViewContentRequest)

      Updates the view content of the given view identifier in the specified Amazon Connect instance.

      It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the invalid input: '&#36'SAVED alias' content will always be updated, but the invalid input: '&#36'LATEST alias' content will only be updated if Status is PUBLISHED.

      Parameters:
      updateViewContentRequest -
      Returns:
      A Java Future containing the result of the UpdateViewContent 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateViewContent

      default CompletableFuture<UpdateViewContentResponse> updateViewContent(Consumer<UpdateViewContentRequest.Builder> updateViewContentRequest)

      Updates the view content of the given view identifier in the specified Amazon Connect instance.

      It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the invalid input: '&#36'SAVED alias' content will always be updated, but the invalid input: '&#36'LATEST alias' content will only be updated if Status is PUBLISHED.


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

      Parameters:
      updateViewContentRequest - A Consumer that will call methods on UpdateViewContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateViewContent 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateViewMetadata

      default CompletableFuture<UpdateViewMetadataResponse> updateViewMetadata(UpdateViewMetadataRequest updateViewMetadataRequest)

      Updates the view metadata. Note that either Name or Description must be provided.

      Parameters:
      updateViewMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateViewMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateViewMetadata

      default CompletableFuture<UpdateViewMetadataResponse> updateViewMetadata(Consumer<UpdateViewMetadataRequest.Builder> updateViewMetadataRequest)

      Updates the view metadata. Note that either Name or Description must be provided.


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

      Parameters:
      updateViewMetadataRequest - A Consumer that will call methods on UpdateViewMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateViewMetadata 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.
      • AccessDeniedException You do not have sufficient permissions to perform this action.
      • InvalidRequestException The request is not valid.
      • InvalidParameterException One or more of the specified parameters are not valid.
      • ResourceNotFoundException The specified resource was not found.
      • InternalServiceException Request processing failed because of an error or failure with the service.
      • TooManyRequestsException Displayed when rate-related API limits are exceeded.
      • DuplicateResourceException A resource with the specified name already exists.
      • ResourceInUseException That resource is already in use. Please try another.
      • 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.
      • ConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ConnectServiceClientConfiguration 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 ConnectAsyncClient create()
      Create a ConnectAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ConnectAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ConnectAsyncClient.