Interface QConnectAsyncClient

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

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.

  • Field Details

  • Method Details

    • activateMessageTemplate

      default CompletableFuture<ActivateMessageTemplateResponse> activateMessageTemplate(ActivateMessageTemplateRequest activateMessageTemplateRequest)

      Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the invalid input: '&#36'ACTIVE_VERSION qualifier later to reference the version that is in active status.

      Parameters:
      activateMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the ActivateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • activateMessageTemplate

      default CompletableFuture<ActivateMessageTemplateResponse> activateMessageTemplate(Consumer<ActivateMessageTemplateRequest.Builder> activateMessageTemplateRequest)

      Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the invalid input: '&#36'ACTIVE_VERSION qualifier later to reference the version that is in active status.


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

      Parameters:
      activateMessageTemplateRequest - A Consumer that will call methods on ActivateMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ActivateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIAgent

      default CompletableFuture<CreateAiAgentResponse> createAIAgent(CreateAiAgentRequest createAiAgentRequest)

      Creates an Amazon Q in Connect AI Agent.

      Parameters:
      createAiAgentRequest -
      Returns:
      A Java Future containing the result of the CreateAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIAgent

      default CompletableFuture<CreateAiAgentResponse> createAIAgent(Consumer<CreateAiAgentRequest.Builder> createAiAgentRequest)

      Creates an Amazon Q in Connect AI Agent.


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

      Parameters:
      createAiAgentRequest - A Consumer that will call methods on CreateAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIAgentVersion

      default CompletableFuture<CreateAiAgentVersionResponse> createAIAgentVersion(CreateAiAgentVersionRequest createAiAgentVersionRequest)

      Creates and Amazon Q in Connect AI Agent version.

      Parameters:
      createAiAgentVersionRequest -
      Returns:
      A Java Future containing the result of the CreateAIAgentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIAgentVersion

      default CompletableFuture<CreateAiAgentVersionResponse> createAIAgentVersion(Consumer<CreateAiAgentVersionRequest.Builder> createAiAgentVersionRequest)

      Creates and Amazon Q in Connect AI Agent version.


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

      Parameters:
      createAiAgentVersionRequest - A Consumer that will call methods on CreateAiAgentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIAgentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIGuardrail

      default CompletableFuture<CreateAiGuardrailResponse> createAIGuardrail(CreateAiGuardrailRequest createAiGuardrailRequest)

      Creates an Amazon Q in Connect AI Guardrail.

      Parameters:
      createAiGuardrailRequest -
      Returns:
      A Java Future containing the result of the CreateAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIGuardrail

      default CompletableFuture<CreateAiGuardrailResponse> createAIGuardrail(Consumer<CreateAiGuardrailRequest.Builder> createAiGuardrailRequest)

      Creates an Amazon Q in Connect AI Guardrail.


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

      Parameters:
      createAiGuardrailRequest - A Consumer that will call methods on CreateAiGuardrailRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIGuardrailVersion

      default CompletableFuture<CreateAiGuardrailVersionResponse> createAIGuardrailVersion(CreateAiGuardrailVersionRequest createAiGuardrailVersionRequest)

      Creates an Amazon Q in Connect AI Guardrail version.

      Parameters:
      createAiGuardrailVersionRequest -
      Returns:
      A Java Future containing the result of the CreateAIGuardrailVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIGuardrailVersion

      default CompletableFuture<CreateAiGuardrailVersionResponse> createAIGuardrailVersion(Consumer<CreateAiGuardrailVersionRequest.Builder> createAiGuardrailVersionRequest)

      Creates an Amazon Q in Connect AI Guardrail version.


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

      Parameters:
      createAiGuardrailVersionRequest - A Consumer that will call methods on CreateAiGuardrailVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIGuardrailVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIPrompt

      default CompletableFuture<CreateAiPromptResponse> createAIPrompt(CreateAiPromptRequest createAiPromptRequest)

      Creates an Amazon Q in Connect AI Prompt.

      Parameters:
      createAiPromptRequest -
      Returns:
      A Java Future containing the result of the CreateAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIPrompt

      default CompletableFuture<CreateAiPromptResponse> createAIPrompt(Consumer<CreateAiPromptRequest.Builder> createAiPromptRequest)

      Creates an Amazon Q in Connect AI Prompt.


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

      Parameters:
      createAiPromptRequest - A Consumer that will call methods on CreateAiPromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIPromptVersion

      default CompletableFuture<CreateAiPromptVersionResponse> createAIPromptVersion(CreateAiPromptVersionRequest createAiPromptVersionRequest)

      Creates an Amazon Q in Connect AI Prompt version.

      Parameters:
      createAiPromptVersionRequest -
      Returns:
      A Java Future containing the result of the CreateAIPromptVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAIPromptVersion

      default CompletableFuture<CreateAiPromptVersionResponse> createAIPromptVersion(Consumer<CreateAiPromptVersionRequest.Builder> createAiPromptVersionRequest)

      Creates an Amazon Q in Connect AI Prompt version.


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

      Parameters:
      createAiPromptVersionRequest - A Consumer that will call methods on CreateAiPromptVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAIPromptVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssistant

      default CompletableFuture<CreateAssistantResponse> createAssistant(CreateAssistantRequest createAssistantRequest)

      Creates an Amazon Q in Connect assistant.

      Parameters:
      createAssistantRequest -
      Returns:
      A Java Future containing the result of the CreateAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssistant

      default CompletableFuture<CreateAssistantResponse> createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest)

      Creates an Amazon Q in Connect assistant.


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

      Parameters:
      createAssistantRequest - A Consumer that will call methods on CreateAssistantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssistantAssociation

      default CompletableFuture<CreateAssistantAssociationResponse> createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest)

      Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

      Parameters:
      createAssistantAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAssistantAssociation

      default CompletableFuture<CreateAssistantAssociationResponse> createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest)

      Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.


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

      Parameters:
      createAssistantAssociationRequest - A Consumer that will call methods on CreateAssistantAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContent

      default CompletableFuture<CreateContentResponse> createContent(CreateContentRequest createContentRequest)

      Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

      Parameters:
      createContentRequest -
      Returns:
      A Java Future containing the result of the CreateContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContent

      default CompletableFuture<CreateContentResponse> createContent(Consumer<CreateContentRequest.Builder> createContentRequest)

      Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.


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

      Parameters:
      createContentRequest - A Consumer that will call methods on CreateContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContentAssociation

      default CompletableFuture<CreateContentAssociationResponse> createContentAssociation(CreateContentAssociationRequest createContentAssociationRequest)

      Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

      After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

      Note the following limitations:

      • You can create only one content association for each content resource in a knowledge base.

      • You can associate a step-by-step guide with multiple content resources.

      For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

      Parameters:
      createContentAssociationRequest -
      Returns:
      A Java Future containing the result of the CreateContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContentAssociation

      default CompletableFuture<CreateContentAssociationResponse> createContentAssociation(Consumer<CreateContentAssociationRequest.Builder> createContentAssociationRequest)

      Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

      After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

      Note the following limitations:

      • You can create only one content association for each content resource in a knowledge base.

      • You can associate a step-by-step guide with multiple content resources.

      For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.


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

      Parameters:
      createContentAssociationRequest - A Consumer that will call methods on CreateContentAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKnowledgeBase

      default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)

      Creates a knowledge base.

      When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

      For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

      1. Call DeleteKnowledgeBase.

      2. Call DeleteDataIntegration.

      3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

      4. Call CreateKnowledgeBase.

      Parameters:
      createKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the CreateKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKnowledgeBase

      default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest)

      Creates a knowledge base.

      When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

      For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

      1. Call DeleteKnowledgeBase.

      2. Call DeleteDataIntegration.

      3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

      4. Call CreateKnowledgeBase.


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

      Parameters:
      createKnowledgeBaseRequest - A Consumer that will call methods on CreateKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplate

      default CompletableFuture<CreateMessageTemplateResponse> createMessageTemplate(CreateMessageTemplateRequest createMessageTemplateRequest)

      Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the invalid input: '&#36'LATEST qualifier to reference the created message template.

      Parameters:
      createMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the CreateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplate

      default CompletableFuture<CreateMessageTemplateResponse> createMessageTemplate(Consumer<CreateMessageTemplateRequest.Builder> createMessageTemplateRequest)

      Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the invalid input: '&#36'LATEST qualifier to reference the created message template.


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

      Parameters:
      createMessageTemplateRequest - A Consumer that will call methods on CreateMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplateAttachment

      default CompletableFuture<CreateMessageTemplateAttachmentResponse> createMessageTemplateAttachment(CreateMessageTemplateAttachmentRequest createMessageTemplateAttachmentRequest)

      Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the invalid input: '&#36'LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

      Parameters:
      createMessageTemplateAttachmentRequest -
      Returns:
      A Java Future containing the result of the CreateMessageTemplateAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplateAttachment

      default CompletableFuture<CreateMessageTemplateAttachmentResponse> createMessageTemplateAttachment(Consumer<CreateMessageTemplateAttachmentRequest.Builder> createMessageTemplateAttachmentRequest)

      Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the invalid input: '&#36'LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.


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

      Parameters:
      createMessageTemplateAttachmentRequest - A Consumer that will call methods on CreateMessageTemplateAttachmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMessageTemplateAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplateVersion

      default CompletableFuture<CreateMessageTemplateVersionResponse> createMessageTemplateVersion(CreateMessageTemplateVersionRequest createMessageTemplateVersionRequest)

      Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with invalid input: '&#36'LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

      Parameters:
      createMessageTemplateVersionRequest -
      Returns:
      A Java Future containing the result of the CreateMessageTemplateVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createMessageTemplateVersion

      default CompletableFuture<CreateMessageTemplateVersionResponse> createMessageTemplateVersion(Consumer<CreateMessageTemplateVersionRequest.Builder> createMessageTemplateVersionRequest)

      Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with invalid input: '&#36'LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.


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

      Parameters:
      createMessageTemplateVersionRequest - A Consumer that will call methods on CreateMessageTemplateVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateMessageTemplateVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuickResponse

      default CompletableFuture<CreateQuickResponseResponse> createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest)

      Creates an Amazon Q in Connect quick response.

      Parameters:
      createQuickResponseRequest -
      Returns:
      A Java Future containing the result of the CreateQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQuickResponse

      default CompletableFuture<CreateQuickResponseResponse> createQuickResponse(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest)

      Creates an Amazon Q in Connect quick response.


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

      Parameters:
      createQuickResponseRequest - A Consumer that will call methods on CreateQuickResponseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSession

      default CompletableFuture<CreateSessionResponse> createSession(CreateSessionRequest createSessionRequest)

      Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

      Parameters:
      createSessionRequest -
      Returns:
      A Java Future containing the result of the CreateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSession

      default CompletableFuture<CreateSessionResponse> createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest)

      Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.


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

      Parameters:
      createSessionRequest - A Consumer that will call methods on CreateSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateMessageTemplate

      default CompletableFuture<DeactivateMessageTemplateResponse> deactivateMessageTemplate(DeactivateMessageTemplateRequest deactivateMessageTemplateRequest)

      Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the invalid input: '&#36'ACTIVE_VERSION qualifier to reference the version in active status.

      Parameters:
      deactivateMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the DeactivateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deactivateMessageTemplate

      default CompletableFuture<DeactivateMessageTemplateResponse> deactivateMessageTemplate(Consumer<DeactivateMessageTemplateRequest.Builder> deactivateMessageTemplateRequest)

      Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the invalid input: '&#36'ACTIVE_VERSION qualifier to reference the version in active status.


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

      Parameters:
      deactivateMessageTemplateRequest - A Consumer that will call methods on DeactivateMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeactivateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIAgent

      default CompletableFuture<DeleteAiAgentResponse> deleteAIAgent(DeleteAiAgentRequest deleteAiAgentRequest)

      Deletes an Amazon Q in Connect AI Agent.

      Parameters:
      deleteAiAgentRequest -
      Returns:
      A Java Future containing the result of the DeleteAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIAgent

      default CompletableFuture<DeleteAiAgentResponse> deleteAIAgent(Consumer<DeleteAiAgentRequest.Builder> deleteAiAgentRequest)

      Deletes an Amazon Q in Connect AI Agent.


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

      Parameters:
      deleteAiAgentRequest - A Consumer that will call methods on DeleteAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIAgentVersion

      default CompletableFuture<DeleteAiAgentVersionResponse> deleteAIAgentVersion(DeleteAiAgentVersionRequest deleteAiAgentVersionRequest)

      Deletes an Amazon Q in Connect AI Agent Version.

      Parameters:
      deleteAiAgentVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteAIAgentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIAgentVersion

      default CompletableFuture<DeleteAiAgentVersionResponse> deleteAIAgentVersion(Consumer<DeleteAiAgentVersionRequest.Builder> deleteAiAgentVersionRequest)

      Deletes an Amazon Q in Connect AI Agent Version.


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

      Parameters:
      deleteAiAgentVersionRequest - A Consumer that will call methods on DeleteAiAgentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIAgentVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIGuardrail

      default CompletableFuture<DeleteAiGuardrailResponse> deleteAIGuardrail(DeleteAiGuardrailRequest deleteAiGuardrailRequest)

      Deletes an Amazon Q in Connect AI Guardrail.

      Parameters:
      deleteAiGuardrailRequest -
      Returns:
      A Java Future containing the result of the DeleteAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIGuardrail

      default CompletableFuture<DeleteAiGuardrailResponse> deleteAIGuardrail(Consumer<DeleteAiGuardrailRequest.Builder> deleteAiGuardrailRequest)

      Deletes an Amazon Q in Connect AI Guardrail.


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

      Parameters:
      deleteAiGuardrailRequest - A Consumer that will call methods on DeleteAiGuardrailRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIGuardrailVersion

      default CompletableFuture<DeleteAiGuardrailVersionResponse> deleteAIGuardrailVersion(DeleteAiGuardrailVersionRequest deleteAiGuardrailVersionRequest)

      Delete and Amazon Q in Connect AI Guardrail version.

      Parameters:
      deleteAiGuardrailVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteAIGuardrailVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIGuardrailVersion

      default CompletableFuture<DeleteAiGuardrailVersionResponse> deleteAIGuardrailVersion(Consumer<DeleteAiGuardrailVersionRequest.Builder> deleteAiGuardrailVersionRequest)

      Delete and Amazon Q in Connect AI Guardrail version.


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

      Parameters:
      deleteAiGuardrailVersionRequest - A Consumer that will call methods on DeleteAiGuardrailVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIGuardrailVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIPrompt

      default CompletableFuture<DeleteAiPromptResponse> deleteAIPrompt(DeleteAiPromptRequest deleteAiPromptRequest)

      Deletes an Amazon Q in Connect AI Prompt.

      Parameters:
      deleteAiPromptRequest -
      Returns:
      A Java Future containing the result of the DeleteAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIPrompt

      default CompletableFuture<DeleteAiPromptResponse> deleteAIPrompt(Consumer<DeleteAiPromptRequest.Builder> deleteAiPromptRequest)

      Deletes an Amazon Q in Connect AI Prompt.


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

      Parameters:
      deleteAiPromptRequest - A Consumer that will call methods on DeleteAiPromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIPromptVersion

      default CompletableFuture<DeleteAiPromptVersionResponse> deleteAIPromptVersion(DeleteAiPromptVersionRequest deleteAiPromptVersionRequest)

      Delete and Amazon Q in Connect AI Prompt version.

      Parameters:
      deleteAiPromptVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteAIPromptVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAIPromptVersion

      default CompletableFuture<DeleteAiPromptVersionResponse> deleteAIPromptVersion(Consumer<DeleteAiPromptVersionRequest.Builder> deleteAiPromptVersionRequest)

      Delete and Amazon Q in Connect AI Prompt version.


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

      Parameters:
      deleteAiPromptVersionRequest - A Consumer that will call methods on DeleteAiPromptVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAIPromptVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssistant

      default CompletableFuture<DeleteAssistantResponse> deleteAssistant(DeleteAssistantRequest deleteAssistantRequest)

      Deletes an assistant.

      Parameters:
      deleteAssistantRequest -
      Returns:
      A Java Future containing the result of the DeleteAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssistant

      default CompletableFuture<DeleteAssistantResponse> deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest)

      Deletes an assistant.


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

      Parameters:
      deleteAssistantRequest - A Consumer that will call methods on DeleteAssistantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssistantAssociation

      default CompletableFuture<DeleteAssistantAssociationResponse> deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)

      Deletes an assistant association.

      Parameters:
      deleteAssistantAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAssistantAssociation

      default CompletableFuture<DeleteAssistantAssociationResponse> deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest)

      Deletes an assistant association.


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

      Parameters:
      deleteAssistantAssociationRequest - A Consumer that will call methods on DeleteAssistantAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContent

      default CompletableFuture<DeleteContentResponse> deleteContent(DeleteContentRequest deleteContentRequest)

      Deletes the content.

      Parameters:
      deleteContentRequest -
      Returns:
      A Java Future containing the result of the DeleteContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContent

      default CompletableFuture<DeleteContentResponse> deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest)

      Deletes the content.


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

      Parameters:
      deleteContentRequest - A Consumer that will call methods on DeleteContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContentAssociation

      default CompletableFuture<DeleteContentAssociationResponse> deleteContentAssociation(DeleteContentAssociationRequest deleteContentAssociationRequest)

      Deletes the content association.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

      Parameters:
      deleteContentAssociationRequest -
      Returns:
      A Java Future containing the result of the DeleteContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContentAssociation

      default CompletableFuture<DeleteContentAssociationResponse> deleteContentAssociation(Consumer<DeleteContentAssociationRequest.Builder> deleteContentAssociationRequest)

      Deletes the content association.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.


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

      Parameters:
      deleteContentAssociationRequest - A Consumer that will call methods on DeleteContentAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImportJob

      default CompletableFuture<DeleteImportJobResponse> deleteImportJob(DeleteImportJobRequest deleteImportJobRequest)

      Deletes the quick response import job.

      Parameters:
      deleteImportJobRequest -
      Returns:
      A Java Future containing the result of the DeleteImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteImportJob

      default CompletableFuture<DeleteImportJobResponse> deleteImportJob(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest)

      Deletes the quick response import job.


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

      Parameters:
      deleteImportJobRequest - A Consumer that will call methods on DeleteImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnowledgeBase

      default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)

      Deletes the knowledge base.

      When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

      Parameters:
      deleteKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the DeleteKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnowledgeBase

      default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest)

      Deletes the knowledge base.

      When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.


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

      Parameters:
      deleteKnowledgeBaseRequest - A Consumer that will call methods on DeleteKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMessageTemplate

      default CompletableFuture<DeleteMessageTemplateResponse> deleteMessageTemplate(DeleteMessageTemplateRequest deleteMessageTemplateRequest)

      Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

      Parameters:
      deleteMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the DeleteMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMessageTemplate

      default CompletableFuture<DeleteMessageTemplateResponse> deleteMessageTemplate(Consumer<DeleteMessageTemplateRequest.Builder> deleteMessageTemplateRequest)

      Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.


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

      Parameters:
      deleteMessageTemplateRequest - A Consumer that will call methods on DeleteMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMessageTemplateAttachment

      default CompletableFuture<DeleteMessageTemplateAttachmentResponse> deleteMessageTemplateAttachment(DeleteMessageTemplateAttachmentRequest deleteMessageTemplateAttachmentRequest)

      Deletes the attachment file from the Amazon Q in Connect message template that is referenced by invalid input: '&#36'LATEST qualifier. Attachments on available message template versions will remain unchanged.

      Parameters:
      deleteMessageTemplateAttachmentRequest -
      Returns:
      A Java Future containing the result of the DeleteMessageTemplateAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteMessageTemplateAttachment

      default CompletableFuture<DeleteMessageTemplateAttachmentResponse> deleteMessageTemplateAttachment(Consumer<DeleteMessageTemplateAttachmentRequest.Builder> deleteMessageTemplateAttachmentRequest)

      Deletes the attachment file from the Amazon Q in Connect message template that is referenced by invalid input: '&#36'LATEST qualifier. Attachments on available message template versions will remain unchanged.


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

      Parameters:
      deleteMessageTemplateAttachmentRequest - A Consumer that will call methods on DeleteMessageTemplateAttachmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteMessageTemplateAttachment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuickResponse

      default CompletableFuture<DeleteQuickResponseResponse> deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest)

      Deletes a quick response.

      Parameters:
      deleteQuickResponseRequest -
      Returns:
      A Java Future containing the result of the DeleteQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQuickResponse

      default CompletableFuture<DeleteQuickResponseResponse> deleteQuickResponse(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest)

      Deletes a quick response.


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

      Parameters:
      deleteQuickResponseRequest - A Consumer that will call methods on DeleteQuickResponseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIAgent

      default CompletableFuture<GetAiAgentResponse> getAIAgent(GetAiAgentRequest getAiAgentRequest)

      Gets an Amazon Q in Connect AI Agent.

      Parameters:
      getAiAgentRequest -
      Returns:
      A Java Future containing the result of the GetAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIAgent

      default CompletableFuture<GetAiAgentResponse> getAIAgent(Consumer<GetAiAgentRequest.Builder> getAiAgentRequest)

      Gets an Amazon Q in Connect AI Agent.


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

      Parameters:
      getAiAgentRequest - A Consumer that will call methods on GetAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIGuardrail

      default CompletableFuture<GetAiGuardrailResponse> getAIGuardrail(GetAiGuardrailRequest getAiGuardrailRequest)

      Gets the Amazon Q in Connect AI Guardrail.

      Parameters:
      getAiGuardrailRequest -
      Returns:
      A Java Future containing the result of the GetAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIGuardrail

      default CompletableFuture<GetAiGuardrailResponse> getAIGuardrail(Consumer<GetAiGuardrailRequest.Builder> getAiGuardrailRequest)

      Gets the Amazon Q in Connect AI Guardrail.


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

      Parameters:
      getAiGuardrailRequest - A Consumer that will call methods on GetAiGuardrailRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIPrompt

      default CompletableFuture<GetAiPromptResponse> getAIPrompt(GetAiPromptRequest getAiPromptRequest)

      Gets and Amazon Q in Connect AI Prompt.

      Parameters:
      getAiPromptRequest -
      Returns:
      A Java Future containing the result of the GetAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAIPrompt

      default CompletableFuture<GetAiPromptResponse> getAIPrompt(Consumer<GetAiPromptRequest.Builder> getAiPromptRequest)

      Gets and Amazon Q in Connect AI Prompt.


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

      Parameters:
      getAiPromptRequest - A Consumer that will call methods on GetAiPromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssistant

      default CompletableFuture<GetAssistantResponse> getAssistant(GetAssistantRequest getAssistantRequest)

      Retrieves information about an assistant.

      Parameters:
      getAssistantRequest -
      Returns:
      A Java Future containing the result of the GetAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssistant

      default CompletableFuture<GetAssistantResponse> getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest)

      Retrieves information about an assistant.


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

      Parameters:
      getAssistantRequest - A Consumer that will call methods on GetAssistantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssistantAssociation

      default CompletableFuture<GetAssistantAssociationResponse> getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest)

      Retrieves information about an assistant association.

      Parameters:
      getAssistantAssociationRequest -
      Returns:
      A Java Future containing the result of the GetAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAssistantAssociation

      default CompletableFuture<GetAssistantAssociationResponse> getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest)

      Retrieves information about an assistant association.


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

      Parameters:
      getAssistantAssociationRequest - A Consumer that will call methods on GetAssistantAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAssistantAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContent

      default CompletableFuture<GetContentResponse> getContent(GetContentRequest getContentRequest)

      Retrieves content, including a pre-signed URL to download the content.

      Parameters:
      getContentRequest -
      Returns:
      A Java Future containing the result of the GetContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContent

      default CompletableFuture<GetContentResponse> getContent(Consumer<GetContentRequest.Builder> getContentRequest)

      Retrieves content, including a pre-signed URL to download the content.


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

      Parameters:
      getContentRequest - A Consumer that will call methods on GetContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContentAssociation

      default CompletableFuture<GetContentAssociationResponse> getContentAssociation(GetContentAssociationRequest getContentAssociationRequest)

      Returns the content association.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

      Parameters:
      getContentAssociationRequest -
      Returns:
      A Java Future containing the result of the GetContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContentAssociation

      default CompletableFuture<GetContentAssociationResponse> getContentAssociation(Consumer<GetContentAssociationRequest.Builder> getContentAssociationRequest)

      Returns the content association.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.


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

      Parameters:
      getContentAssociationRequest - A Consumer that will call methods on GetContentAssociationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContentAssociation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContentSummary

      default CompletableFuture<GetContentSummaryResponse> getContentSummary(GetContentSummaryRequest getContentSummaryRequest)

      Retrieves summary information about the content.

      Parameters:
      getContentSummaryRequest -
      Returns:
      A Java Future containing the result of the GetContentSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContentSummary

      default CompletableFuture<GetContentSummaryResponse> getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest)

      Retrieves summary information about the content.


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

      Parameters:
      getContentSummaryRequest - A Consumer that will call methods on GetContentSummaryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContentSummary operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJob

      default CompletableFuture<GetImportJobResponse> getImportJob(GetImportJobRequest getImportJobRequest)

      Retrieves the started import job.

      Parameters:
      getImportJobRequest -
      Returns:
      A Java Future containing the result of the GetImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getImportJob

      default CompletableFuture<GetImportJobResponse> getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest)

      Retrieves the started import job.


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

      Parameters:
      getImportJobRequest - A Consumer that will call methods on GetImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKnowledgeBase

      default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)

      Retrieves information about the knowledge base.

      Parameters:
      getKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the GetKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKnowledgeBase

      default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest)

      Retrieves information about the knowledge base.


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

      Parameters:
      getKnowledgeBaseRequest - A Consumer that will call methods on GetKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetKnowledgeBase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMessageTemplate

      default CompletableFuture<GetMessageTemplateResponse> getMessageTemplate(GetMessageTemplateRequest getMessageTemplateRequest)

      Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier invalid input: '&#36'ACTIVE_VERSION | invalid input: '&#36'LATEST . If it is not supplied, then invalid input: '&#36'LATEST is assumed implicitly.

      Parameters:
      getMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the GetMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMessageTemplate

      default CompletableFuture<GetMessageTemplateResponse> getMessageTemplate(Consumer<GetMessageTemplateRequest.Builder> getMessageTemplateRequest)

      Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier invalid input: '&#36'ACTIVE_VERSION | invalid input: '&#36'LATEST . If it is not supplied, then invalid input: '&#36'LATEST is assumed implicitly.


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

      Parameters:
      getMessageTemplateRequest - A Consumer that will call methods on GetMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNextMessage

      default CompletableFuture<GetNextMessageResponse> getNextMessage(GetNextMessageRequest getNextMessageRequest)

      Retrieves next message on an Amazon Q in Connect session.

      Parameters:
      getNextMessageRequest -
      Returns:
      A Java Future containing the result of the GetNextMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getNextMessage

      default CompletableFuture<GetNextMessageResponse> getNextMessage(Consumer<GetNextMessageRequest.Builder> getNextMessageRequest)

      Retrieves next message on an Amazon Q in Connect session.


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

      Parameters:
      getNextMessageRequest - A Consumer that will call methods on GetNextMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetNextMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuickResponse

      default CompletableFuture<GetQuickResponseResponse> getQuickResponse(GetQuickResponseRequest getQuickResponseRequest)

      Retrieves the quick response.

      Parameters:
      getQuickResponseRequest -
      Returns:
      A Java Future containing the result of the GetQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQuickResponse

      default CompletableFuture<GetQuickResponseResponse> getQuickResponse(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest)

      Retrieves the quick response.


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

      Parameters:
      getQuickResponseRequest - A Consumer that will call methods on GetQuickResponseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommendations

      @Deprecated default CompletableFuture<GetRecommendationsResponse> getRecommendations(GetRecommendationsRequest getRecommendationsRequest)
      Deprecated.
      GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

      Parameters:
      getRecommendationsRequest -
      Returns:
      A Java Future containing the result of the GetRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRecommendations

      @Deprecated default CompletableFuture<GetRecommendationsResponse> getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)
      Deprecated.
      GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.


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

      Parameters:
      getRecommendationsRequest - A Consumer that will call methods on GetRecommendationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSession

      default CompletableFuture<GetSessionResponse> getSession(GetSessionRequest getSessionRequest)

      Retrieves information for a specified session.

      Parameters:
      getSessionRequest -
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSession

      default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)

      Retrieves information for a specified session.


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

      Parameters:
      getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentVersions

      default CompletableFuture<ListAiAgentVersionsResponse> listAIAgentVersions(ListAiAgentVersionsRequest listAiAgentVersionsRequest)

      List AI Agent versions.

      Parameters:
      listAiAgentVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAIAgentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentVersions

      default CompletableFuture<ListAiAgentVersionsResponse> listAIAgentVersions(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest)

      List AI Agent versions.


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

      Parameters:
      listAiAgentVersionsRequest - A Consumer that will call methods on ListAiAgentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIAgentVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentVersionsPaginator

      default ListAIAgentVersionsPublisher listAIAgentVersionsPaginator(ListAiAgentVersionsRequest listAiAgentVersionsRequest)

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

      Parameters:
      listAiAgentVersionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentVersionsPaginator

      default ListAIAgentVersionsPublisher listAIAgentVersionsPaginator(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest)

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


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

      Parameters:
      listAiAgentVersionsRequest - A Consumer that will call methods on ListAiAgentVersionsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgents

      default CompletableFuture<ListAiAgentsResponse> listAIAgents(ListAiAgentsRequest listAiAgentsRequest)

      Lists AI Agents.

      Parameters:
      listAiAgentsRequest -
      Returns:
      A Java Future containing the result of the ListAIAgents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgents

      default CompletableFuture<ListAiAgentsResponse> listAIAgents(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest)

      Lists AI Agents.


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

      Parameters:
      listAiAgentsRequest - A Consumer that will call methods on ListAiAgentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIAgents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentsPaginator

      default ListAIAgentsPublisher listAIAgentsPaginator(ListAiAgentsRequest listAiAgentsRequest)

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

      Parameters:
      listAiAgentsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIAgentsPaginator

      default ListAIAgentsPublisher listAIAgentsPaginator(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest)

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


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

      Parameters:
      listAiAgentsRequest - A Consumer that will call methods on ListAiAgentsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailVersions

      default CompletableFuture<ListAiGuardrailVersionsResponse> listAIGuardrailVersions(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest)

      Lists AI Guardrail versions.

      Parameters:
      listAiGuardrailVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAIGuardrailVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailVersions

      default CompletableFuture<ListAiGuardrailVersionsResponse> listAIGuardrailVersions(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest)

      Lists AI Guardrail versions.


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

      Parameters:
      listAiGuardrailVersionsRequest - A Consumer that will call methods on ListAiGuardrailVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIGuardrailVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailVersionsPaginator

      default ListAIGuardrailVersionsPublisher listAIGuardrailVersionsPaginator(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest)

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

      Parameters:
      listAiGuardrailVersionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailVersionsPaginator

      default ListAIGuardrailVersionsPublisher listAIGuardrailVersionsPaginator(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest)

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


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

      Parameters:
      listAiGuardrailVersionsRequest - A Consumer that will call methods on ListAiGuardrailVersionsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrails

      default CompletableFuture<ListAiGuardrailsResponse> listAIGuardrails(ListAiGuardrailsRequest listAiGuardrailsRequest)

      Lists the AI Guardrails available on the Amazon Q in Connect assistant.

      Parameters:
      listAiGuardrailsRequest -
      Returns:
      A Java Future containing the result of the ListAIGuardrails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrails

      default CompletableFuture<ListAiGuardrailsResponse> listAIGuardrails(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest)

      Lists the AI Guardrails available on the Amazon Q in Connect assistant.


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

      Parameters:
      listAiGuardrailsRequest - A Consumer that will call methods on ListAiGuardrailsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIGuardrails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailsPaginator

      default ListAIGuardrailsPublisher listAIGuardrailsPaginator(ListAiGuardrailsRequest listAiGuardrailsRequest)

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

      Parameters:
      listAiGuardrailsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIGuardrailsPaginator

      default ListAIGuardrailsPublisher listAIGuardrailsPaginator(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest)

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


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

      Parameters:
      listAiGuardrailsRequest - A Consumer that will call methods on ListAiGuardrailsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptVersions

      default CompletableFuture<ListAiPromptVersionsResponse> listAIPromptVersions(ListAiPromptVersionsRequest listAiPromptVersionsRequest)

      Lists AI Prompt versions.

      Parameters:
      listAiPromptVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAIPromptVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptVersions

      default CompletableFuture<ListAiPromptVersionsResponse> listAIPromptVersions(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest)

      Lists AI Prompt versions.


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

      Parameters:
      listAiPromptVersionsRequest - A Consumer that will call methods on ListAiPromptVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIPromptVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptVersionsPaginator

      default ListAIPromptVersionsPublisher listAIPromptVersionsPaginator(ListAiPromptVersionsRequest listAiPromptVersionsRequest)

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

      Parameters:
      listAiPromptVersionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptVersionsPaginator

      default ListAIPromptVersionsPublisher listAIPromptVersionsPaginator(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest)

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


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

      Parameters:
      listAiPromptVersionsRequest - A Consumer that will call methods on ListAiPromptVersionsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPrompts

      default CompletableFuture<ListAiPromptsResponse> listAIPrompts(ListAiPromptsRequest listAiPromptsRequest)

      Lists the AI Prompts available on the Amazon Q in Connect assistant.

      Parameters:
      listAiPromptsRequest -
      Returns:
      A Java Future containing the result of the ListAIPrompts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPrompts

      default CompletableFuture<ListAiPromptsResponse> listAIPrompts(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest)

      Lists the AI Prompts available on the Amazon Q in Connect assistant.


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

      Parameters:
      listAiPromptsRequest - A Consumer that will call methods on ListAiPromptsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAIPrompts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptsPaginator

      default ListAIPromptsPublisher listAIPromptsPaginator(ListAiPromptsRequest listAiPromptsRequest)

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

      Parameters:
      listAiPromptsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAIPromptsPaginator

      default ListAIPromptsPublisher listAIPromptsPaginator(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest)

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


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

      Parameters:
      listAiPromptsRequest - A Consumer that will call methods on ListAiPromptsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ThrottlingException The throttling limit has been exceeded.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantAssociations

      default CompletableFuture<ListAssistantAssociationsResponse> listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest)

      Lists information about assistant associations.

      Parameters:
      listAssistantAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListAssistantAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantAssociations

      default CompletableFuture<ListAssistantAssociationsResponse> listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest)

      Lists information about assistant associations.


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

      Parameters:
      listAssistantAssociationsRequest - A Consumer that will call methods on ListAssistantAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssistantAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantAssociationsPaginator

      default ListAssistantAssociationsPublisher listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest)

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

      Parameters:
      listAssistantAssociationsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantAssociationsPaginator

      default ListAssistantAssociationsPublisher listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest)

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


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

      Parameters:
      listAssistantAssociationsRequest - A Consumer that will call methods on ListAssistantAssociationsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistants

      default CompletableFuture<ListAssistantsResponse> listAssistants(ListAssistantsRequest listAssistantsRequest)

      Lists information about assistants.

      Parameters:
      listAssistantsRequest -
      Returns:
      A Java Future containing the result of the ListAssistants operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistants

      default CompletableFuture<ListAssistantsResponse> listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest)

      Lists information about assistants.


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

      Parameters:
      listAssistantsRequest - A Consumer that will call methods on ListAssistantsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAssistants operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantsPaginator

      default ListAssistantsPublisher listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest)

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

      Parameters:
      listAssistantsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAssistantsPaginator

      default ListAssistantsPublisher listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest)

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


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

      Parameters:
      listAssistantsRequest - A Consumer that will call methods on ListAssistantsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentAssociations

      default CompletableFuture<ListContentAssociationsResponse> listContentAssociations(ListContentAssociationsRequest listContentAssociationsRequest)

      Lists the content associations.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

      Parameters:
      listContentAssociationsRequest -
      Returns:
      A Java Future containing the result of the ListContentAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentAssociations

      default CompletableFuture<ListContentAssociationsResponse> listContentAssociations(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest)

      Lists the content associations.

      For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.


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

      Parameters:
      listContentAssociationsRequest - A Consumer that will call methods on ListContentAssociationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContentAssociations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentAssociationsPaginator

      default ListContentAssociationsPublisher listContentAssociationsPaginator(ListContentAssociationsRequest listContentAssociationsRequest)

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

      Parameters:
      listContentAssociationsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentAssociationsPaginator

      default ListContentAssociationsPublisher listContentAssociationsPaginator(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest)

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


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

      Parameters:
      listContentAssociationsRequest - A Consumer that will call methods on ListContentAssociationsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContents

      default CompletableFuture<ListContentsResponse> listContents(ListContentsRequest listContentsRequest)

      Lists the content.

      Parameters:
      listContentsRequest -
      Returns:
      A Java Future containing the result of the ListContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContents

      default CompletableFuture<ListContentsResponse> listContents(Consumer<ListContentsRequest.Builder> listContentsRequest)

      Lists the content.


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

      Parameters:
      listContentsRequest - A Consumer that will call methods on ListContentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentsPaginator

      default ListContentsPublisher listContentsPaginator(ListContentsRequest listContentsRequest)

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

      Parameters:
      listContentsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listContentsPaginator

      default ListContentsPublisher listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest)

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


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

      Parameters:
      listContentsRequest - A Consumer that will call methods on ListContentsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImportJobs

      default CompletableFuture<ListImportJobsResponse> listImportJobs(ListImportJobsRequest listImportJobsRequest)

      Lists information about import jobs.

      Parameters:
      listImportJobsRequest -
      Returns:
      A Java Future containing the result of the ListImportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImportJobs

      default CompletableFuture<ListImportJobsResponse> listImportJobs(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest)

      Lists information about import jobs.


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

      Parameters:
      listImportJobsRequest - A Consumer that will call methods on ListImportJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListImportJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImportJobsPaginator

      default ListImportJobsPublisher listImportJobsPaginator(ListImportJobsRequest listImportJobsRequest)

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

      Parameters:
      listImportJobsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listImportJobsPaginator

      default ListImportJobsPublisher listImportJobsPaginator(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest)

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


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

      Parameters:
      listImportJobsRequest - A Consumer that will call methods on ListImportJobsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBases

      default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

      Lists the knowledge bases.

      Parameters:
      listKnowledgeBasesRequest -
      Returns:
      A Java Future containing the result of the ListKnowledgeBases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBases

      default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)

      Lists the knowledge bases.


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

      Parameters:
      listKnowledgeBasesRequest - A Consumer that will call methods on ListKnowledgeBasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListKnowledgeBases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBasesPaginator

      default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

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

      Parameters:
      listKnowledgeBasesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBasesPaginator

      default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)

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


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

      Parameters:
      listKnowledgeBasesRequest - A Consumer that will call methods on ListKnowledgeBasesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplateVersions

      default CompletableFuture<ListMessageTemplateVersionsResponse> listMessageTemplateVersions(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest)

      Lists all the available versions for the specified Amazon Q in Connect message template.

      Parameters:
      listMessageTemplateVersionsRequest -
      Returns:
      A Java Future containing the result of the ListMessageTemplateVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplateVersions

      default CompletableFuture<ListMessageTemplateVersionsResponse> listMessageTemplateVersions(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest)

      Lists all the available versions for the specified Amazon Q in Connect message template.


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

      Parameters:
      listMessageTemplateVersionsRequest - A Consumer that will call methods on ListMessageTemplateVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMessageTemplateVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplateVersionsPaginator

      default ListMessageTemplateVersionsPublisher listMessageTemplateVersionsPaginator(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest)

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

      Parameters:
      listMessageTemplateVersionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplateVersionsPaginator

      default ListMessageTemplateVersionsPublisher listMessageTemplateVersionsPaginator(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest)

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


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

      Parameters:
      listMessageTemplateVersionsRequest - A Consumer that will call methods on ListMessageTemplateVersionsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplates

      default CompletableFuture<ListMessageTemplatesResponse> listMessageTemplates(ListMessageTemplatesRequest listMessageTemplatesRequest)

      Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

      Parameters:
      listMessageTemplatesRequest -
      Returns:
      A Java Future containing the result of the ListMessageTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplates

      default CompletableFuture<ListMessageTemplatesResponse> listMessageTemplates(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest)

      Lists all the available Amazon Q in Connect message templates for the specified knowledge base.


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

      Parameters:
      listMessageTemplatesRequest - A Consumer that will call methods on ListMessageTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMessageTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplatesPaginator

      default ListMessageTemplatesPublisher listMessageTemplatesPaginator(ListMessageTemplatesRequest listMessageTemplatesRequest)

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

      Parameters:
      listMessageTemplatesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessageTemplatesPaginator

      default ListMessageTemplatesPublisher listMessageTemplatesPaginator(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest)

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


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

      Parameters:
      listMessageTemplatesRequest - A Consumer that will call methods on ListMessageTemplatesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessages

      default CompletableFuture<ListMessagesResponse> listMessages(ListMessagesRequest listMessagesRequest)

      Lists messages on an Amazon Q in Connect session.

      Parameters:
      listMessagesRequest -
      Returns:
      A Java Future containing the result of the ListMessages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessages

      default CompletableFuture<ListMessagesResponse> listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest)

      Lists messages on an Amazon Q in Connect session.


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

      Parameters:
      listMessagesRequest - A Consumer that will call methods on ListMessagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListMessages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessagesPaginator

      default ListMessagesPublisher listMessagesPaginator(ListMessagesRequest listMessagesRequest)

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

      Parameters:
      listMessagesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listMessagesPaginator

      default ListMessagesPublisher listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest)

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


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

      Parameters:
      listMessagesRequest - A Consumer that will call methods on ListMessagesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickResponses

      default CompletableFuture<ListQuickResponsesResponse> listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest)

      Lists information about quick response.

      Parameters:
      listQuickResponsesRequest -
      Returns:
      A Java Future containing the result of the ListQuickResponses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickResponses

      default CompletableFuture<ListQuickResponsesResponse> listQuickResponses(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest)

      Lists information about quick response.


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

      Parameters:
      listQuickResponsesRequest - A Consumer that will call methods on ListQuickResponsesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQuickResponses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickResponsesPaginator

      default ListQuickResponsesPublisher listQuickResponsesPaginator(ListQuickResponsesRequest listQuickResponsesRequest)

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

      Parameters:
      listQuickResponsesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQuickResponsesPaginator

      default ListQuickResponsesPublisher listQuickResponsesPaginator(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest)

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


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

      Parameters:
      listQuickResponsesRequest - A Consumer that will call methods on ListQuickResponsesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.

      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.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.


      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.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyRecommendationsReceived

      default CompletableFuture<NotifyRecommendationsReceivedResponse> notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest)

      Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

      Parameters:
      notifyRecommendationsReceivedRequest -
      Returns:
      A Java Future containing the result of the NotifyRecommendationsReceived operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • notifyRecommendationsReceived

      default CompletableFuture<NotifyRecommendationsReceivedResponse> notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest)

      Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.


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

      Parameters:
      notifyRecommendationsReceivedRequest - A Consumer that will call methods on NotifyRecommendationsReceivedRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the NotifyRecommendationsReceived operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFeedback

      default CompletableFuture<PutFeedbackResponse> putFeedback(PutFeedbackRequest putFeedbackRequest)

      Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

      Parameters:
      putFeedbackRequest -
      Returns:
      A Java Future containing the result of the PutFeedback operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putFeedback

      default CompletableFuture<PutFeedbackResponse> putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest)

      Provides feedback against the specified assistant for the specified target. This API only supports generative targets.


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

      Parameters:
      putFeedbackRequest - A Consumer that will call methods on PutFeedbackRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutFeedback operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryAssistant

      @Deprecated default CompletableFuture<QueryAssistantResponse> queryAssistant(QueryAssistantRequest queryAssistantRequest)
      Deprecated.
      QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

      Parameters:
      queryAssistantRequest -
      Returns:
      A Java Future containing the result of the QueryAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryAssistant

      @Deprecated default CompletableFuture<QueryAssistantResponse> queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest)
      Deprecated.
      QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

      Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.


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

      Parameters:
      queryAssistantRequest - A Consumer that will call methods on QueryAssistantRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the QueryAssistant operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryAssistantPaginator

      @Deprecated default QueryAssistantPublisher queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest)
      Deprecated.
      QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

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

      Parameters:
      queryAssistantRequest -
      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.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • queryAssistantPaginator

      @Deprecated default QueryAssistantPublisher queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest)
      Deprecated.
      QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

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


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

      Parameters:
      queryAssistantRequest - A Consumer that will call methods on QueryAssistantRequest.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.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeAssistantAIAgent

      default CompletableFuture<RemoveAssistantAiAgentResponse> removeAssistantAIAgent(RemoveAssistantAiAgentRequest removeAssistantAiAgentRequest)

      Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

      Parameters:
      removeAssistantAiAgentRequest -
      Returns:
      A Java Future containing the result of the RemoveAssistantAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeAssistantAIAgent

      default CompletableFuture<RemoveAssistantAiAgentResponse> removeAssistantAIAgent(Consumer<RemoveAssistantAiAgentRequest.Builder> removeAssistantAiAgentRequest)

      Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.


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

      Parameters:
      removeAssistantAiAgentRequest - A Consumer that will call methods on RemoveAssistantAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveAssistantAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeKnowledgeBaseTemplateUri

      default CompletableFuture<RemoveKnowledgeBaseTemplateUriResponse> removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)

      Removes a URI template from a knowledge base.

      Parameters:
      removeKnowledgeBaseTemplateUriRequest -
      Returns:
      A Java Future containing the result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeKnowledgeBaseTemplateUri

      default CompletableFuture<RemoveKnowledgeBaseTemplateUriResponse> removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest)

      Removes a URI template from a knowledge base.


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

      Parameters:
      removeKnowledgeBaseTemplateUriRequest - A Consumer that will call methods on RemoveKnowledgeBaseTemplateUriRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • renderMessageTemplate

      default CompletableFuture<RenderMessageTemplateResponse> renderMessageTemplate(RenderMessageTemplateRequest renderMessageTemplateRequest)

      Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

      Parameters:
      renderMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the RenderMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • renderMessageTemplate

      default CompletableFuture<RenderMessageTemplateResponse> renderMessageTemplate(Consumer<RenderMessageTemplateRequest.Builder> renderMessageTemplateRequest)

      Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.


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

      Parameters:
      renderMessageTemplateRequest - A Consumer that will call methods on RenderMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RenderMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContent

      default CompletableFuture<SearchContentResponse> searchContent(SearchContentRequest searchContentRequest)

      Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

      Parameters:
      searchContentRequest -
      Returns:
      A Java Future containing the result of the SearchContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContent

      default CompletableFuture<SearchContentResponse> searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest)

      Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.


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

      Parameters:
      searchContentRequest - A Consumer that will call methods on SearchContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContentPaginator

      default SearchContentPublisher searchContentPaginator(SearchContentRequest searchContentRequest)

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

      Parameters:
      searchContentRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchContentPaginator

      default SearchContentPublisher searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest)

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


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

      Parameters:
      searchContentRequest - A Consumer that will call methods on SearchContentRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchMessageTemplates

      default CompletableFuture<SearchMessageTemplatesResponse> searchMessageTemplates(SearchMessageTemplatesRequest searchMessageTemplatesRequest)

      Searches for Amazon Q in Connect message templates in the specified knowledge base.

      Parameters:
      searchMessageTemplatesRequest -
      Returns:
      A Java Future containing the result of the SearchMessageTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchMessageTemplates

      default CompletableFuture<SearchMessageTemplatesResponse> searchMessageTemplates(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest)

      Searches for Amazon Q in Connect message templates in the specified knowledge base.


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

      Parameters:
      searchMessageTemplatesRequest - A Consumer that will call methods on SearchMessageTemplatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchMessageTemplates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchMessageTemplatesPaginator

      default SearchMessageTemplatesPublisher searchMessageTemplatesPaginator(SearchMessageTemplatesRequest searchMessageTemplatesRequest)

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

      Parameters:
      searchMessageTemplatesRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchMessageTemplatesPaginator

      default SearchMessageTemplatesPublisher searchMessageTemplatesPaginator(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest)

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


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

      Parameters:
      searchMessageTemplatesRequest - A Consumer that will call methods on SearchMessageTemplatesRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickResponses

      default CompletableFuture<SearchQuickResponsesResponse> searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest)

      Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

      Parameters:
      searchQuickResponsesRequest -
      Returns:
      A Java Future containing the result of the SearchQuickResponses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickResponses

      default CompletableFuture<SearchQuickResponsesResponse> searchQuickResponses(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest)

      Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.


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

      Parameters:
      searchQuickResponsesRequest - A Consumer that will call methods on SearchQuickResponsesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchQuickResponses operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickResponsesPaginator

      default SearchQuickResponsesPublisher searchQuickResponsesPaginator(SearchQuickResponsesRequest searchQuickResponsesRequest)

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

      Parameters:
      searchQuickResponsesRequest -
      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.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchQuickResponsesPaginator

      default SearchQuickResponsesPublisher searchQuickResponsesPaginator(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest)

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


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

      Parameters:
      searchQuickResponsesRequest - A Consumer that will call methods on SearchQuickResponsesRequest.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.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSessions

      default CompletableFuture<SearchSessionsResponse> searchSessions(SearchSessionsRequest searchSessionsRequest)

      Searches for sessions.

      Parameters:
      searchSessionsRequest -
      Returns:
      A Java Future containing the result of the SearchSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSessions

      default CompletableFuture<SearchSessionsResponse> searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest)

      Searches for sessions.


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

      Parameters:
      searchSessionsRequest - A Consumer that will call methods on SearchSessionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SearchSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSessionsPaginator

      default SearchSessionsPublisher searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest)

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

      Parameters:
      searchSessionsRequest -
      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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • searchSessionsPaginator

      default SearchSessionsPublisher searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest)

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


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

      Parameters:
      searchSessionsRequest - A Consumer that will call methods on SearchSessionsRequest.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.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendMessage

      default CompletableFuture<SendMessageResponse> sendMessage(SendMessageRequest sendMessageRequest)

      Submits a message to the Amazon Q in Connect session.

      Parameters:
      sendMessageRequest -
      Returns:
      A Java Future containing the result of the SendMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendMessage

      default CompletableFuture<SendMessageResponse> sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest)

      Submits a message to the Amazon Q in Connect session.


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

      Parameters:
      sendMessageRequest - A Consumer that will call methods on SendMessageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendMessage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContentUpload

      default CompletableFuture<StartContentUploadResponse> startContentUpload(StartContentUploadRequest startContentUploadRequest)

      Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

      Parameters:
      startContentUploadRequest -
      Returns:
      A Java Future containing the result of the StartContentUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startContentUpload

      default CompletableFuture<StartContentUploadResponse> startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest)

      Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.


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

      Parameters:
      startContentUploadRequest - A Consumer that will call methods on StartContentUploadRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartContentUpload operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startImportJob

      default CompletableFuture<StartImportJobResponse> startImportJob(StartImportJobRequest startImportJobRequest)

      Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

      • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

      Parameters:
      startImportJobRequest -
      Returns:
      A Java Future containing the result of the StartImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startImportJob

      default CompletableFuture<StartImportJobResponse> startImportJob(Consumer<StartImportJobRequest.Builder> startImportJobRequest)

      Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

      • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.


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

      Parameters:
      startImportJobRequest - A Consumer that will call methods on StartImportJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartImportJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.

      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.
      • TooManyTagsException Amazon Q in Connect throws this exception if you have too many tags in your tag set.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.


      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.
      • TooManyTagsException Amazon Q in Connect throws this exception if you have too many tags in your tag set.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException 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.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIAgent

      default CompletableFuture<UpdateAiAgentResponse> updateAIAgent(UpdateAiAgentRequest updateAiAgentRequest)

      Updates an AI Agent.

      Parameters:
      updateAiAgentRequest -
      Returns:
      A Java Future containing the result of the UpdateAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIAgent

      default CompletableFuture<UpdateAiAgentResponse> updateAIAgent(Consumer<UpdateAiAgentRequest.Builder> updateAiAgentRequest)

      Updates an AI Agent.


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

      Parameters:
      updateAiAgentRequest - A Consumer that will call methods on UpdateAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIGuardrail

      default CompletableFuture<UpdateAiGuardrailResponse> updateAIGuardrail(UpdateAiGuardrailRequest updateAiGuardrailRequest)

      Updates an AI Guardrail.

      Parameters:
      updateAiGuardrailRequest -
      Returns:
      A Java Future containing the result of the UpdateAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIGuardrail

      default CompletableFuture<UpdateAiGuardrailResponse> updateAIGuardrail(Consumer<UpdateAiGuardrailRequest.Builder> updateAiGuardrailRequest)

      Updates an AI Guardrail.


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

      Parameters:
      updateAiGuardrailRequest - A Consumer that will call methods on UpdateAiGuardrailRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAIGuardrail operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIPrompt

      default CompletableFuture<UpdateAiPromptResponse> updateAIPrompt(UpdateAiPromptRequest updateAiPromptRequest)

      Updates an AI Prompt.

      Parameters:
      updateAiPromptRequest -
      Returns:
      A Java Future containing the result of the UpdateAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAIPrompt

      default CompletableFuture<UpdateAiPromptResponse> updateAIPrompt(Consumer<UpdateAiPromptRequest.Builder> updateAiPromptRequest)

      Updates an AI Prompt.


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

      Parameters:
      updateAiPromptRequest - A Consumer that will call methods on UpdateAiPromptRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAIPrompt operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssistantAIAgent

      default CompletableFuture<UpdateAssistantAiAgentResponse> updateAssistantAIAgent(UpdateAssistantAiAgentRequest updateAssistantAiAgentRequest)

      Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

      Parameters:
      updateAssistantAiAgentRequest -
      Returns:
      A Java Future containing the result of the UpdateAssistantAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAssistantAIAgent

      default CompletableFuture<UpdateAssistantAiAgentResponse> updateAssistantAIAgent(Consumer<UpdateAssistantAiAgentRequest.Builder> updateAssistantAiAgentRequest)

      Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.


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

      Parameters:
      updateAssistantAiAgentRequest - A Consumer that will call methods on UpdateAssistantAiAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAssistantAIAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContent

      default CompletableFuture<UpdateContentResponse> updateContent(UpdateContentRequest updateContentRequest)

      Updates information about the content.

      Parameters:
      updateContentRequest -
      Returns:
      A Java Future containing the result of the UpdateContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • PreconditionFailedException The provided revisionId does not match, indicating the content has been modified since it was last read.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContent

      default CompletableFuture<UpdateContentResponse> updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest)

      Updates information about the content.


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

      Parameters:
      updateContentRequest - A Consumer that will call methods on UpdateContentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • PreconditionFailedException The provided revisionId does not match, indicating the content has been modified since it was last read.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateKnowledgeBaseTemplateUri

      default CompletableFuture<UpdateKnowledgeBaseTemplateUriResponse> updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest)

      Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in invalid input: '&#36'{variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '&#36'{Id}*/view.

      Parameters:
      updateKnowledgeBaseTemplateUriRequest -
      Returns:
      A Java Future containing the result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateKnowledgeBaseTemplateUri

      default CompletableFuture<UpdateKnowledgeBaseTemplateUriResponse> updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest)

      Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in invalid input: '&#36'{variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '&#36'{Id}*/view.


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

      Parameters:
      updateKnowledgeBaseTemplateUriRequest - A Consumer that will call methods on UpdateKnowledgeBaseTemplateUriRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMessageTemplate

      default CompletableFuture<UpdateMessageTemplateResponse> updateMessageTemplate(UpdateMessageTemplateRequest updateMessageTemplateRequest)

      Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the invalid input: '&#36'LATEST qualifier. Any modification will only apply to the message template that is referenced by the invalid input: '&#36'LATEST qualifier. The fields for all available versions will remain unchanged.

      Parameters:
      updateMessageTemplateRequest -
      Returns:
      A Java Future containing the result of the UpdateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMessageTemplate

      default CompletableFuture<UpdateMessageTemplateResponse> updateMessageTemplate(Consumer<UpdateMessageTemplateRequest.Builder> updateMessageTemplateRequest)

      Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the invalid input: '&#36'LATEST qualifier. Any modification will only apply to the message template that is referenced by the invalid input: '&#36'LATEST qualifier. The fields for all available versions will remain unchanged.


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

      Parameters:
      updateMessageTemplateRequest - A Consumer that will call methods on UpdateMessageTemplateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMessageTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMessageTemplateMetadata

      default CompletableFuture<UpdateMessageTemplateMetadataResponse> updateMessageTemplateMetadata(UpdateMessageTemplateMetadataRequest updateMessageTemplateMetadataRequest)

      Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the invalid input: '&#36'LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

      Parameters:
      updateMessageTemplateMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateMessageTemplateMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateMessageTemplateMetadata

      default CompletableFuture<UpdateMessageTemplateMetadataResponse> updateMessageTemplateMetadata(Consumer<UpdateMessageTemplateMetadataRequest.Builder> updateMessageTemplateMetadataRequest)

      Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the invalid input: '&#36'LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.


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

      Parameters:
      updateMessageTemplateMetadataRequest - A Consumer that will call methods on UpdateMessageTemplateMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateMessageTemplateMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • 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.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickResponse

      default CompletableFuture<UpdateQuickResponseResponse> updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest)

      Updates an existing Amazon Q in Connect quick response.

      Parameters:
      updateQuickResponseRequest -
      Returns:
      A Java Future containing the result of the UpdateQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • PreconditionFailedException The provided revisionId does not match, indicating the content has been modified since it was last read.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQuickResponse

      default CompletableFuture<UpdateQuickResponseResponse> updateQuickResponse(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest)

      Updates an existing Amazon Q in Connect quick response.


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

      Parameters:
      updateQuickResponseRequest - A Consumer that will call methods on UpdateQuickResponseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQuickResponse operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ConflictException The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • PreconditionFailedException The provided revisionId does not match, indicating the content has been modified since it was last read.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSession

      default CompletableFuture<UpdateSessionResponse> updateSession(UpdateSessionRequest updateSessionRequest)

      Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

      Parameters:
      updateSessionRequest -
      Returns:
      A Java Future containing the result of the UpdateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSession

      default CompletableFuture<UpdateSessionResponse> updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest)

      Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.


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

      Parameters:
      updateSessionRequest - A Consumer that will call methods on UpdateSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSessionData

      default CompletableFuture<UpdateSessionDataResponse> updateSessionData(UpdateSessionDataRequest updateSessionDataRequest)

      Updates the data stored on an Amazon Q in Connect Session.

      Parameters:
      updateSessionDataRequest -
      Returns:
      A Java Future containing the result of the UpdateSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSessionData

      default CompletableFuture<UpdateSessionDataResponse> updateSessionData(Consumer<UpdateSessionDataRequest.Builder> updateSessionDataRequest)

      Updates the data stored on an Amazon Q in Connect Session.


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

      Parameters:
      updateSessionDataRequest - A Consumer that will call methods on UpdateSessionDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ValidationException The input fails to satisfy the constraints specified by a service.
      • UnauthorizedException You do not have permission to perform this action.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • ResourceNotFoundException The specified resource does not exist.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QConnectException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default QConnectServiceClientConfiguration 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 QConnectAsyncClient create()
      Create a QConnectAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static QConnectAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a QConnectAsyncClient.