Package-level declarations
Types
Used to configure access permissions for a document.
A list of principals. Each principal can be either a USER or a GROUP and can be designated document access permissions of either ALLOW or DENY.
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
Performs an Amazon Q plugin action during a non-streaming chat conversation.
A user input field in an plugin action execution payload.
An output event that Amazon Q returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q.
A user input field in an plugin action review payload.
Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
Summary information for an Amazon Q application.
Configuration information about the file upload during chat feature for your application.
A file directly uploaded into a web experience chat.
The details of a file uploaded during chat.
Configuration information for the file upload during chat feature.
Enables filtering of responses based on document attributes or metadata fields.
Information about the basic authentication credentials used to configure a plugin.
Provides information about the phrases blocked from chat by your chat control configuration.
Updates a blocked phrases configuration in your Amazon Q application.
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
A rule for configuring how Amazon Q responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.
A conversation in an Amazon Q application.
A data source in an Amazon Q application.
Provides information about an Amazon Q data source connector synchronization job.
Maps a batch delete document request to a specific Amazon Q data source connector sync job.
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
Provides information on boosting DATE type document attributes.
A document deleted from an Amazon Q data source connector.
A document attribute or metadata field.
Provides information on boosting supported Amazon Q document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q prioritizes generating responses from content that matches the boosted document attributes.
Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q.
The value of a document attribute. You can only provide one value for a document attribute.
The contents of a document.
The details of a document within an Amazon Q index.
Provides the configuration information for altering document metadata and content during the document ingestion process.
The identifier of the data source Amazon Q will generate responses from.
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.
Provides information about a data source sync error.
A list of documents that could not be removed from an Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
A list of users or sub groups that belong to a group. This is for generating Amazon Q chat results only from document a user has access to.
Provides the details of a group's status.
Summary information for groups.
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.
Provides information about index capacity configuration.
Provides information about the number of documents in an index.
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q.
An issue occurred with the internal server used for your Amazon Q service. Wait some minutes and try again, or contact Support for help.
Stores an Amazon Kendra index as a retriever.
You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.
The sub groups that belong to a group.
The users that belong to a group.
End user feedback on an AI-generated web experience chat message usefulness.
Configuration information for an Amazon Q index.
Provides information on boosting NUMBER type document attributes.
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
Authentication configuration information for an Amazon Q plugin.
Provides information about a group associated with the principal.
Provides information about a user associated with a principal.
Base class for all service related exceptions thrown by the QBusiness client
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
Provides information on how the retriever used for your Amazon Q application is configured.
Provides configuration information about a rule.
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.
You have exceeded the set limits for your Amazon Q service.
The documents used to generate an Amazon Q web experience response.
Provides information on boosting STRING type document attributes.
Provides information on boosting STRING_LIST type document attributes.
Provides information about text documents in an index.
Provides information about a text extract in a chat response that can be attributed to a source document.
The request was denied due to throttling. Reduce the number of requests and try again.
The topic specific controls configured for an Amazon Q application.
Provides information about users and groups associated with a topic control rule.
The input doesn't meet the constraints set by the Amazon Q service. Provide the correct input and try again.
The input failed to meet the constraints specified by Amazon Q in a specified field.
Provides information for an Amazon Q web experience.
Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.