Interface QAppsAsyncClient

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

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see Amazon Q Apps capabilities in the Amazon Q Business User Guide.

For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations.

For information about the IAM access control permissions you need to use the Amazon Q Apps API, see IAM role for the Amazon Q Business web experience including Amazon Q Apps in the Amazon Q Business User Guide.

  • Field Details

  • Method Details

    • associateLibraryItemReview

      default CompletableFuture<AssociateLibraryItemReviewResponse> associateLibraryItemReview(AssociateLibraryItemReviewRequest associateLibraryItemReviewRequest)

      Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.

      Parameters:
      associateLibraryItemReviewRequest -
      Returns:
      A Java Future containing the result of the AssociateLibraryItemReview operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateLibraryItemReview

      default CompletableFuture<AssociateLibraryItemReviewResponse> associateLibraryItemReview(Consumer<AssociateLibraryItemReviewRequest.Builder> associateLibraryItemReviewRequest)

      Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.


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

      Parameters:
      associateLibraryItemReviewRequest - A Consumer that will call methods on AssociateLibraryItemReviewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateLibraryItemReview operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateQAppWithUser

      default CompletableFuture<AssociateQAppWithUserResponse> associateQAppWithUser(AssociateQAppWithUserRequest associateQAppWithUserRequest)

      This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.

      Parameters:
      associateQAppWithUserRequest -
      Returns:
      A Java Future containing the result of the AssociateQAppWithUser operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateQAppWithUser

      default CompletableFuture<AssociateQAppWithUserResponse> associateQAppWithUser(Consumer<AssociateQAppWithUserRequest.Builder> associateQAppWithUserRequest)

      This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.


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

      Parameters:
      associateQAppWithUserRequest - A Consumer that will call methods on AssociateQAppWithUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateQAppWithUser operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchCreateCategory

      default CompletableFuture<BatchCreateCategoryResponse> batchCreateCategory(BatchCreateCategoryRequest batchCreateCategoryRequest)

      Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

      Parameters:
      batchCreateCategoryRequest -
      Returns:
      A Java Future containing the result of the BatchCreateCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchCreateCategory

      default CompletableFuture<BatchCreateCategoryResponse> batchCreateCategory(Consumer<BatchCreateCategoryRequest.Builder> batchCreateCategoryRequest)

      Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.


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

      Parameters:
      batchCreateCategoryRequest - A Consumer that will call methods on BatchCreateCategoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchCreateCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteCategory

      default CompletableFuture<BatchDeleteCategoryResponse> batchDeleteCategory(BatchDeleteCategoryRequest batchDeleteCategoryRequest)

      Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

      Parameters:
      batchDeleteCategoryRequest -
      Returns:
      A Java Future containing the result of the BatchDeleteCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchDeleteCategory

      default CompletableFuture<BatchDeleteCategoryResponse> batchDeleteCategory(Consumer<BatchDeleteCategoryRequest.Builder> batchDeleteCategoryRequest)

      Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.


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

      Parameters:
      batchDeleteCategoryRequest - A Consumer that will call methods on BatchDeleteCategoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchDeleteCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdateCategory

      default CompletableFuture<BatchUpdateCategoryResponse> batchUpdateCategory(BatchUpdateCategoryRequest batchUpdateCategoryRequest)

      Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

      Parameters:
      batchUpdateCategoryRequest -
      Returns:
      A Java Future containing the result of the BatchUpdateCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchUpdateCategory

      default CompletableFuture<BatchUpdateCategoryResponse> batchUpdateCategory(Consumer<BatchUpdateCategoryRequest.Builder> batchUpdateCategoryRequest)

      Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.


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

      Parameters:
      batchUpdateCategoryRequest - A Consumer that will call methods on BatchUpdateCategoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchUpdateCategory operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLibraryItem

      default CompletableFuture<CreateLibraryItemResponse> createLibraryItem(CreateLibraryItemRequest createLibraryItemRequest)

      Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

      Parameters:
      createLibraryItemRequest -
      Returns:
      A Java Future containing the result of the CreateLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLibraryItem

      default CompletableFuture<CreateLibraryItemResponse> createLibraryItem(Consumer<CreateLibraryItemRequest.Builder> createLibraryItemRequest)

      Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.


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

      Parameters:
      createLibraryItemRequest - A Consumer that will call methods on CreateLibraryItemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedUrl

      default CompletableFuture<CreatePresignedUrlResponse> createPresignedUrl(CreatePresignedUrlRequest createPresignedUrlRequest)

      Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level.

      Parameters:
      createPresignedUrlRequest -
      Returns:
      A Java Future containing the result of the CreatePresignedUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPresignedUrl

      default CompletableFuture<CreatePresignedUrlResponse> createPresignedUrl(Consumer<CreatePresignedUrlRequest.Builder> createPresignedUrlRequest)

      Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level.


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

      Parameters:
      createPresignedUrlRequest - A Consumer that will call methods on CreatePresignedUrlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePresignedUrl operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQApp

      default CompletableFuture<CreateQAppResponse> createQApp(CreateQAppRequest createQAppRequest)

      Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

      Parameters:
      createQAppRequest -
      Returns:
      A Java Future containing the result of the CreateQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createQApp

      default CompletableFuture<CreateQAppResponse> createQApp(Consumer<CreateQAppRequest.Builder> createQAppRequest)

      Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.


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

      Parameters:
      createQAppRequest - A Consumer that will call methods on CreateQAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLibraryItem

      default CompletableFuture<DeleteLibraryItemResponse> deleteLibraryItem(DeleteLibraryItemRequest deleteLibraryItemRequest)

      Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.

      Parameters:
      deleteLibraryItemRequest -
      Returns:
      A Java Future containing the result of the DeleteLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLibraryItem

      default CompletableFuture<DeleteLibraryItemResponse> deleteLibraryItem(Consumer<DeleteLibraryItemRequest.Builder> deleteLibraryItemRequest)

      Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.


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

      Parameters:
      deleteLibraryItemRequest - A Consumer that will call methods on DeleteLibraryItemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQApp

      default CompletableFuture<DeleteQAppResponse> deleteQApp(DeleteQAppRequest deleteQAppRequest)

      Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

      Parameters:
      deleteQAppRequest -
      Returns:
      A Java Future containing the result of the DeleteQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteQApp

      default CompletableFuture<DeleteQAppResponse> deleteQApp(Consumer<DeleteQAppRequest.Builder> deleteQAppRequest)

      Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.


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

      Parameters:
      deleteQAppRequest - A Consumer that will call methods on DeleteQAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQAppPermissions

      default CompletableFuture<DescribeQAppPermissionsResponse> describeQAppPermissions(DescribeQAppPermissionsRequest describeQAppPermissionsRequest)

      Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

      Parameters:
      describeQAppPermissionsRequest -
      Returns:
      A Java Future containing the result of the DescribeQAppPermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeQAppPermissions

      default CompletableFuture<DescribeQAppPermissionsResponse> describeQAppPermissions(Consumer<DescribeQAppPermissionsRequest.Builder> describeQAppPermissionsRequest)

      Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.


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

      Parameters:
      describeQAppPermissionsRequest - A Consumer that will call methods on DescribeQAppPermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeQAppPermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLibraryItemReview

      default CompletableFuture<DisassociateLibraryItemReviewResponse> disassociateLibraryItemReview(DisassociateLibraryItemReviewRequest disassociateLibraryItemReviewRequest)

      Removes a rating or review previously submitted by the user for a library item.

      Parameters:
      disassociateLibraryItemReviewRequest -
      Returns:
      A Java Future containing the result of the DisassociateLibraryItemReview operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateLibraryItemReview

      default CompletableFuture<DisassociateLibraryItemReviewResponse> disassociateLibraryItemReview(Consumer<DisassociateLibraryItemReviewRequest.Builder> disassociateLibraryItemReviewRequest)

      Removes a rating or review previously submitted by the user for a library item.


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

      Parameters:
      disassociateLibraryItemReviewRequest - A Consumer that will call methods on DisassociateLibraryItemReviewRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateLibraryItemReview operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateQAppFromUser

      default CompletableFuture<DisassociateQAppFromUserResponse> disassociateQAppFromUser(DisassociateQAppFromUserRequest disassociateQAppFromUserRequest)

      Disassociates a Q App from a user removing the user's access to run the Q App.

      Parameters:
      disassociateQAppFromUserRequest -
      Returns:
      A Java Future containing the result of the DisassociateQAppFromUser operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateQAppFromUser

      default CompletableFuture<DisassociateQAppFromUserResponse> disassociateQAppFromUser(Consumer<DisassociateQAppFromUserRequest.Builder> disassociateQAppFromUserRequest)

      Disassociates a Q App from a user removing the user's access to run the Q App.


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

      Parameters:
      disassociateQAppFromUserRequest - A Consumer that will call methods on DisassociateQAppFromUserRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateQAppFromUser operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportQAppSessionData

      default CompletableFuture<ExportQAppSessionDataResponse> exportQAppSessionData(ExportQAppSessionDataRequest exportQAppSessionDataRequest)

      Exports the collected data of a Q App data collection session.

      Parameters:
      exportQAppSessionDataRequest -
      Returns:
      A Java Future containing the result of the ExportQAppSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportQAppSessionData

      default CompletableFuture<ExportQAppSessionDataResponse> exportQAppSessionData(Consumer<ExportQAppSessionDataRequest.Builder> exportQAppSessionDataRequest)

      Exports the collected data of a Q App data collection session.


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

      Parameters:
      exportQAppSessionDataRequest - A Consumer that will call methods on ExportQAppSessionDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportQAppSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLibraryItem

      default CompletableFuture<GetLibraryItemResponse> getLibraryItem(GetLibraryItemRequest getLibraryItemRequest)

      Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

      Parameters:
      getLibraryItemRequest -
      Returns:
      A Java Future containing the result of the GetLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLibraryItem

      default CompletableFuture<GetLibraryItemResponse> getLibraryItem(Consumer<GetLibraryItemRequest.Builder> getLibraryItemRequest)

      Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.


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

      Parameters:
      getLibraryItemRequest - A Consumer that will call methods on GetLibraryItemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQApp

      default CompletableFuture<GetQAppResponse> getQApp(GetQAppRequest getQAppRequest)

      Retrieves the full details of an Q App, including its definition specifying the cards and flow.

      Parameters:
      getQAppRequest -
      Returns:
      A Java Future containing the result of the GetQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQApp

      default CompletableFuture<GetQAppResponse> getQApp(Consumer<GetQAppRequest.Builder> getQAppRequest)

      Retrieves the full details of an Q App, including its definition specifying the cards and flow.


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

      Parameters:
      getQAppRequest - A Consumer that will call methods on GetQAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQAppSession

      default CompletableFuture<GetQAppSessionResponse> getQAppSession(GetQAppSessionRequest getQAppSessionRequest)

      Retrieves the current state and results for an active session of an Amazon Q App.

      Parameters:
      getQAppSessionRequest -
      Returns:
      A Java Future containing the result of the GetQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQAppSession

      default CompletableFuture<GetQAppSessionResponse> getQAppSession(Consumer<GetQAppSessionRequest.Builder> getQAppSessionRequest)

      Retrieves the current state and results for an active session of an Amazon Q App.


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

      Parameters:
      getQAppSessionRequest - A Consumer that will call methods on GetQAppSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQAppSessionMetadata

      default CompletableFuture<GetQAppSessionMetadataResponse> getQAppSessionMetadata(GetQAppSessionMetadataRequest getQAppSessionMetadataRequest)

      Retrieves the current configuration of a Q App session.

      Parameters:
      getQAppSessionMetadataRequest -
      Returns:
      A Java Future containing the result of the GetQAppSessionMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getQAppSessionMetadata

      default CompletableFuture<GetQAppSessionMetadataResponse> getQAppSessionMetadata(Consumer<GetQAppSessionMetadataRequest.Builder> getQAppSessionMetadataRequest)

      Retrieves the current configuration of a Q App session.


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

      Parameters:
      getQAppSessionMetadataRequest - A Consumer that will call methods on GetQAppSessionMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetQAppSessionMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importDocument

      default CompletableFuture<ImportDocumentResponse> importDocument(ImportDocumentRequest importDocumentRequest)

      Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.

      Parameters:
      importDocumentRequest -
      Returns:
      A Java Future containing the result of the ImportDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importDocument

      default CompletableFuture<ImportDocumentResponse> importDocument(Consumer<ImportDocumentRequest.Builder> importDocumentRequest)

      Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.


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

      Parameters:
      importDocumentRequest - A Consumer that will call methods on ImportDocumentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportDocument operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCategories

      default CompletableFuture<ListCategoriesResponse> listCategories(ListCategoriesRequest listCategoriesRequest)

      Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

      Parameters:
      listCategoriesRequest -
      Returns:
      A Java Future containing the result of the ListCategories operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCategories

      default CompletableFuture<ListCategoriesResponse> listCategories(Consumer<ListCategoriesRequest.Builder> listCategoriesRequest)

      Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.


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

      Parameters:
      listCategoriesRequest - A Consumer that will call methods on ListCategoriesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCategories operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLibraryItems

      default CompletableFuture<ListLibraryItemsResponse> listLibraryItems(ListLibraryItemsRequest listLibraryItemsRequest)

      Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

      Parameters:
      listLibraryItemsRequest -
      Returns:
      A Java Future containing the result of the ListLibraryItems operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLibraryItems

      default CompletableFuture<ListLibraryItemsResponse> listLibraryItems(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)

      Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.


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

      Parameters:
      listLibraryItemsRequest - A Consumer that will call methods on ListLibraryItemsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListLibraryItems operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLibraryItemsPaginator

      default ListLibraryItemsPublisher listLibraryItemsPaginator(ListLibraryItemsRequest listLibraryItemsRequest)

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

      Parameters:
      listLibraryItemsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLibraryItemsPaginator

      default ListLibraryItemsPublisher listLibraryItemsPaginator(Consumer<ListLibraryItemsRequest.Builder> listLibraryItemsRequest)

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


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

      Parameters:
      listLibraryItemsRequest - A Consumer that will call methods on ListLibraryItemsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException The requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQAppSessionData

      default CompletableFuture<ListQAppSessionDataResponse> listQAppSessionData(ListQAppSessionDataRequest listQAppSessionDataRequest)

      Lists the collected data of a Q App data collection session.

      Parameters:
      listQAppSessionDataRequest -
      Returns:
      A Java Future containing the result of the ListQAppSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQAppSessionData

      default CompletableFuture<ListQAppSessionDataResponse> listQAppSessionData(Consumer<ListQAppSessionDataRequest.Builder> listQAppSessionDataRequest)

      Lists the collected data of a Q App data collection session.


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

      Parameters:
      listQAppSessionDataRequest - A Consumer that will call methods on ListQAppSessionDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQAppSessionData operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQApps

      default CompletableFuture<ListQAppsResponse> listQApps(ListQAppsRequest listQAppsRequest)

      Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

      Parameters:
      listQAppsRequest -
      Returns:
      A Java Future containing the result of the ListQApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQApps

      default CompletableFuture<ListQAppsResponse> listQApps(Consumer<ListQAppsRequest.Builder> listQAppsRequest)

      Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..


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

      Parameters:
      listQAppsRequest - A Consumer that will call methods on ListQAppsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListQApps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQAppsPaginator

      default ListQAppsPublisher listQAppsPaginator(ListQAppsRequest listQAppsRequest)

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

      Parameters:
      listQAppsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listQAppsPaginator

      default ListQAppsPublisher listQAppsPaginator(Consumer<ListQAppsRequest.Builder> listQAppsRequest)

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


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

      Parameters:
      listQAppsRequest - A Consumer that will call methods on ListQAppsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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 associated with an Amazon Q Apps 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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 associated with an Amazon Q Apps 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • predictQApp

      default CompletableFuture<PredictQAppResponse> predictQApp(PredictQAppRequest predictQAppRequest)

      Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.

      Parameters:
      predictQAppRequest -
      Returns:
      A Java Future containing the result of the PredictQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • predictQApp

      default CompletableFuture<PredictQAppResponse> predictQApp(Consumer<PredictQAppRequest.Builder> predictQAppRequest)

      Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.


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

      Parameters:
      predictQAppRequest - A Consumer that will call methods on PredictQAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PredictQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startQAppSession

      default CompletableFuture<StartQAppSessionResponse> startQAppSession(StartQAppSessionRequest startQAppSessionRequest)

      Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

      Each Q App session will be condensed into a single conversation in the web experience.

      Parameters:
      startQAppSessionRequest -
      Returns:
      A Java Future containing the result of the StartQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startQAppSession

      default CompletableFuture<StartQAppSessionResponse> startQAppSession(Consumer<StartQAppSessionRequest.Builder> startQAppSessionRequest)

      Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

      Each Q App session will be condensed into a single conversation in the web experience.


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

      Parameters:
      startQAppSessionRequest - A Consumer that will call methods on StartQAppSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopQAppSession

      default CompletableFuture<StopQAppSessionResponse> stopQAppSession(StopQAppSessionRequest stopQAppSessionRequest)

      Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

      Parameters:
      stopQAppSessionRequest -
      Returns:
      A Java Future containing the result of the StopQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopQAppSession

      default CompletableFuture<StopQAppSessionResponse> stopQAppSession(Consumer<StopQAppSessionRequest.Builder> stopQAppSessionRequest)

      Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.


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

      Parameters:
      stopQAppSessionRequest - A Consumer that will call methods on StopQAppSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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)

      Associates tags with an Amazon Q Apps 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.
      • ResourceNotFoundException The requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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)

      Associates tags with an Amazon Q Apps 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.
      • ResourceNotFoundException The requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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)

      Disassociates tags from an Amazon Q Apps 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException 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)

      Disassociates tags from an Amazon Q Apps 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLibraryItem

      default CompletableFuture<UpdateLibraryItemResponse> updateLibraryItem(UpdateLibraryItemRequest updateLibraryItemRequest)

      Updates the library item for an Amazon Q App.

      Parameters:
      updateLibraryItemRequest -
      Returns:
      A Java Future containing the result of the UpdateLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLibraryItem

      default CompletableFuture<UpdateLibraryItemResponse> updateLibraryItem(Consumer<UpdateLibraryItemRequest.Builder> updateLibraryItemRequest)

      Updates the library item for an Amazon Q App.


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

      Parameters:
      updateLibraryItemRequest - A Consumer that will call methods on UpdateLibraryItemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLibraryItem operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLibraryItemMetadata

      default CompletableFuture<UpdateLibraryItemMetadataResponse> updateLibraryItemMetadata(UpdateLibraryItemMetadataRequest updateLibraryItemMetadataRequest)

      Updates the verification status of a library item for an Amazon Q App.

      Parameters:
      updateLibraryItemMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateLibraryItemMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLibraryItemMetadata

      default CompletableFuture<UpdateLibraryItemMetadataResponse> updateLibraryItemMetadata(Consumer<UpdateLibraryItemMetadataRequest.Builder> updateLibraryItemMetadataRequest)

      Updates the verification status of a library item for an Amazon Q App.


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

      Parameters:
      updateLibraryItemMetadataRequest - A Consumer that will call methods on UpdateLibraryItemMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLibraryItemMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ConflictException The requested operation could not be completed due to a conflict with the current state of the resource.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQApp

      default CompletableFuture<UpdateQAppResponse> updateQApp(UpdateQAppRequest updateQAppRequest)

      Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

      Parameters:
      updateQAppRequest -
      Returns:
      A Java Future containing the result of the UpdateQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQApp

      default CompletableFuture<UpdateQAppResponse> updateQApp(Consumer<UpdateQAppRequest.Builder> updateQAppRequest)

      Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.


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

      Parameters:
      updateQAppRequest - A Consumer that will call methods on UpdateQAppRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQApp operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ContentTooLargeException The requested operation could not be completed because the content exceeds the maximum allowed size.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppPermissions

      default CompletableFuture<UpdateQAppPermissionsResponse> updateQAppPermissions(UpdateQAppPermissionsRequest updateQAppPermissionsRequest)

      Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

      Parameters:
      updateQAppPermissionsRequest -
      Returns:
      A Java Future containing the result of the UpdateQAppPermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppPermissions

      default CompletableFuture<UpdateQAppPermissionsResponse> updateQAppPermissions(Consumer<UpdateQAppPermissionsRequest.Builder> updateQAppPermissionsRequest)

      Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.


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

      Parameters:
      updateQAppPermissionsRequest - A Consumer that will call methods on UpdateQAppPermissionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQAppPermissions operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppSession

      default CompletableFuture<UpdateQAppSessionResponse> updateQAppSession(UpdateQAppSessionRequest updateQAppSessionRequest)

      Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

      Parameters:
      updateQAppSessionRequest -
      Returns:
      A Java Future containing the result of the UpdateQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppSession

      default CompletableFuture<UpdateQAppSessionResponse> updateQAppSession(Consumer<UpdateQAppSessionRequest.Builder> updateQAppSessionRequest)

      Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.


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

      Parameters:
      updateQAppSessionRequest - A Consumer that will call methods on UpdateQAppSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQAppSession operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppSessionMetadata

      default CompletableFuture<UpdateQAppSessionMetadataResponse> updateQAppSessionMetadata(UpdateQAppSessionMetadataRequest updateQAppSessionMetadataRequest)

      Updates the configuration metadata of a session for a given Q App sessionId.

      Parameters:
      updateQAppSessionMetadataRequest -
      Returns:
      A Java Future containing the result of the UpdateQAppSessionMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateQAppSessionMetadata

      default CompletableFuture<UpdateQAppSessionMetadataResponse> updateQAppSessionMetadata(Consumer<UpdateQAppSessionMetadataRequest.Builder> updateQAppSessionMetadataRequest)

      Updates the configuration metadata of a session for a given Q App sessionId.


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

      Parameters:
      updateQAppSessionMetadataRequest - A Consumer that will call methods on UpdateQAppSessionMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateQAppSessionMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed 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 requested resource could not be found.
      • AccessDeniedException The client is not authorized to perform the requested operation.
      • ValidationException The input failed to satisfy the constraints specified by the service.
      • InternalServerException An internal service error occurred while processing the request.
      • UnauthorizedException The client is not authenticated or authorized to perform the requested operation.
      • ServiceQuotaExceededException The requested operation could not be completed because it would exceed the service's quota or limit.
      • ThrottlingException The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • QAppsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static QAppsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a QAppsAsyncClient.