JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.qapps

Interface AWSQApps

  • All Known Subinterfaces:
    AWSQAppsAsync
    All Known Implementing Classes:
    AbstractAWSQApps, AbstractAWSQAppsAsync, AWSQAppsAsyncClient, AWSQAppsClient


    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
    public interface AWSQApps
    Interface for accessing QApps.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSQApps instead.

    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 an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see Amazon Q App in the Amazon Q Business User Guide.

    • Method Detail

      • associateQAppWithUser

        AssociateQAppWithUserResult 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:
        Result of the AssociateQAppWithUser operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • createQApp

        CreateQAppResult 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:
        Result of the CreateQApp operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • deleteLibraryItem

        DeleteLibraryItemResult 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:
        Result of the DeleteLibraryItem operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • deleteQApp

        DeleteQAppResult 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:
        Result of the DeleteQApp operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • getLibraryItem

        GetLibraryItemResult 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:
        Result of the GetLibraryItem operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • getQApp

        GetQAppResult getQApp(GetQAppRequest getQAppRequest)

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

        Parameters:
        getQAppRequest -
        Returns:
        Result of the GetQApp operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • importDocument

        ImportDocumentResult 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:
        Result of the ImportDocument operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • listLibraryItems

        ListLibraryItemsResult 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:
        Result of the ListLibraryItems operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • listQApps

        ListQAppsResult 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:
        Result of the ListQApps operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • predictQApp

        PredictQAppResult 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:
        Result of the PredictQApp operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • startQAppSession

        StartQAppSessionResult 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:
        Result of the StartQAppSession operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • stopQAppSession

        StopQAppSessionResult 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:
        Result of the StopQAppSession operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • updateQApp

        UpdateQAppResult updateQApp(UpdateQAppRequest updateQAppRequest)

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

        Parameters:
        updateQAppRequest -
        Returns:
        Result of the UpdateQApp operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • updateQAppSession

        UpdateQAppSessionResult 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:
        Result of the UpdateQAppSession operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation
      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /