aws-elixir

View Source AWS.QApps (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

associate_library_item_review(client, input, options \\ [])

Associates a rating or review for a library item with the user submitting the request.

associate_q_app_with_user(client, input, options \\ [])

This operation creates a link between the user's identity calling the operation and a specific Q App.

batch_create_category(client, input, options \\ [])

Creates Categories for the Amazon Q Business application environment instance.

batch_delete_category(client, input, options \\ [])

Deletes Categories for the Amazon Q Business application environment instance.

batch_update_category(client, input, options \\ [])

Updates Categories for the Amazon Q Business application environment instance.

create_library_item(client, input, options \\ [])

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

create_presigned_url(client, input, options \\ [])

Creates a presigned URL for an S3 POST operation to upload a file.

create_q_app(client, input, options \\ [])

Creates a new Amazon Q App based on the provided definition.

delete_library_item(client, input, options \\ [])

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.

delete_q_app(client, input, options \\ [])

Deletes an Amazon Q App owned by the user.

describe_q_app_permissions(client, app_id, instance_id, options \\ [])

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

disassociate_library_item_review(client, input, options \\ [])

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

disassociate_q_app_from_user(client, input, options \\ [])

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

export_q_app_session_data(client, input, options \\ [])

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

get_library_item(client, app_id \\ nil, library_item_id, instance_id, options \\ [])

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

get_q_app(client, app_id, app_version \\ nil, instance_id, options \\ [])

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

get_q_app_session(client, session_id, instance_id, options \\ [])

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

get_q_app_session_metadata(client, session_id, instance_id, options \\ [])

Retrieves the current configuration of a Q App session.

import_document(client, input, options \\ [])

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.

list_categories(client, instance_id, options \\ [])

Lists the categories of a Amazon Q Business application environment instance.

list_library_items(client, category_id \\ nil, limit \\ nil, next_token \\ nil, instance_id, options \\ [])

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

list_q_app_session_data(client, session_id, instance_id, options \\ [])

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

list_q_apps(client, limit \\ nil, next_token \\ nil, instance_id, options \\ [])

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.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags associated with an Amazon Q Apps resource.

metadata()
predict_q_app(client, input, options \\ [])

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.

start_q_app_session(client, input, options \\ [])

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

stop_q_app_session(client, input, options \\ [])

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses.

tag_resource(client, resource_arn, input, options \\ [])

Associates tags with an Amazon Q Apps resource.

untag_resource(client, resource_arn, input, options \\ [])

Disassociates tags from an Amazon Q Apps resource.

update_library_item(client, input, options \\ [])

Updates the library item for an Amazon Q App.

update_library_item_metadata(client, input, options \\ [])

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

update_q_app(client, input, options \\ [])

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

update_q_app_permissions(client, input, options \\ [])

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

update_q_app_session(client, input, options \\ [])

Updates the session for a given Q App sessionId.

update_q_app_session_metadata(client, input, options \\ [])

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

Link to this section Functions

Link to this function

associate_library_item_review(client, input, options \\ [])

View Source

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.

Link to this function

associate_q_app_with_user(client, input, options \\ [])

View Source

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.

Link to this function

batch_create_category(client, input, options \\ [])

View Source

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.

Link to this function

batch_delete_category(client, input, options \\ [])

View Source

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.

Link to this function

batch_update_category(client, input, options \\ [])

View Source

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.

Link to this function

create_library_item(client, input, options \\ [])

View Source

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

Link to this function

create_presigned_url(client, input, options \\ [])

View Source

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.

Link to this function

create_q_app(client, input, options \\ [])

View Source

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.

Link to this function

delete_library_item(client, input, options \\ [])

View Source

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.

Link to this function

delete_q_app(client, input, options \\ [])

View Source

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.

Link to this function

describe_q_app_permissions(client, app_id, instance_id, options \\ [])

View Source

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

Link to this function

disassociate_library_item_review(client, input, options \\ [])

View Source

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

Link to this function

disassociate_q_app_from_user(client, input, options \\ [])

View Source

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

Link to this function

export_q_app_session_data(client, input, options \\ [])

View Source

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

Link to this function

get_library_item(client, app_id \\ nil, library_item_id, instance_id, options \\ [])

View Source

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

Link to this function

get_q_app(client, app_id, app_version \\ nil, instance_id, options \\ [])

View Source

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

Link to this function

get_q_app_session(client, session_id, instance_id, options \\ [])

View Source

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

Link to this function

get_q_app_session_metadata(client, session_id, instance_id, options \\ [])

View Source

Retrieves the current configuration of a Q App session.

Link to this function

import_document(client, input, options \\ [])

View Source

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.

Link to this function

list_categories(client, instance_id, options \\ [])

View Source

Lists the categories of a Amazon Q Business application environment instance.

For more information, see Custom labels for Amazon Q Apps.

Link to this function

list_library_items(client, category_id \\ nil, limit \\ nil, next_token \\ nil, instance_id, options \\ [])

View Source

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

Link to this function

list_q_app_session_data(client, session_id, instance_id, options \\ [])

View Source

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

Link to this function

list_q_apps(client, limit \\ nil, next_token \\ nil, instance_id, options \\ [])

View Source

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..

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags associated with an Amazon Q Apps resource.

Link to this function

metadata()

View Source
Link to this function

predict_q_app(client, input, options \\ [])

View Source

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.

Link to this function

start_q_app_session(client, input, options \\ [])

View Source

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.

Link to this function

stop_q_app_session(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Associates tags with an Amazon Q Apps resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Disassociates tags from an Amazon Q Apps resource.

Link to this function

update_library_item(client, input, options \\ [])

View Source

Updates the library item for an Amazon Q App.

Link to this function

update_library_item_metadata(client, input, options \\ [])

View Source

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

Link to this function

update_q_app(client, input, options \\ [])

View Source

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

Link to this function

update_q_app_permissions(client, input, options \\ [])

View Source

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

Link to this function

update_q_app_session(client, input, options \\ [])

View Source

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.

Link to this function

update_q_app_session_metadata(client, input, options \\ [])

View Source

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