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.
Specifies an allowed action and its associated filter configuration.
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.
A user input field in an plugin action execution payload.
Specifies filters to apply to an allowed action.
An output event that Amazon Q Business 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 Business.
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
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 Business for Amazon Q Business to perform the requested plugin action.
Summary information for an Amazon Q Business plugin action.
Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
Summary information for an Amazon Q Business application.
Configuration information about the file upload during chat feature for your application.
The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.
The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application.
Represents a group associated with a given user in the access control system.
Represents an associated user in the access control system.
An attachment in an Amazon Q Business conversation.
This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat.
A file input event activated by a end user request to upload files into their 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.
Configuration settings for audio content extraction and processing.
Details about an audio source, including its identifier, format, and time information.
A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
An authentication verification event activated by an end user request to use a custom plugin.
Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.
An authentication verification event response by a third party authentication server to Amazon Q Business.
Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
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 Business application.
The container for browser extension configuration for an Amazon Q Business web experience.
The streaming input for the Chat API.
Configuration information for Amazon Q Business conversation modes.
The streaming output for the Chat API.
Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.
Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.
A configuration event activated by an end user request to select a specific chat mode.
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.
A rule for configuring how Amazon Q Business 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 Business application for a specific topic control configuration.
Specifies the source of content to search in.
A conversation in an Amazon Q Business application.
The source reference for an existing attachment in an existing conversation.
The source reference for an existing attachment.
Configuration information required to invoke chat in CREATOR_MODE.
Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
Configuration information required to create a custom plugin.
Provides summary information about a data accessor.
A union type that contains the specific authentication configuration based on the authentication type selected.
Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
The type of authentication mechanism used by the data accessor.
Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
A data source in an Amazon Q Business application.
Provides information about an Amazon Q Business data source connector synchronization job.
Maps a batch delete document request to a specific Amazon Q Business 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 Business data source connector.
Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.
Represents a condition in the document's ACL, specifying access rules for users and groups.
Represents a group in the document's ACL, used to define access permissions for multiple users collectively.
Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.
Represents a user in the document's ACL, used to define access permissions for individual users.
A document attribute or metadata field.
Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business 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 Business.
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 Business index.
Provides the configuration information for altering document metadata and content during the document ingestion process.
The identifier of the data source Amazon Q Business will generate responses from.
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
The end of the streaming input for the Chat API.
Provides information about a Amazon Q Business request error.
An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
A failed file upload during web experience chat.
A list of documents that could not be removed from an Amazon Q Business 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 Business chat results only from document a user has access to.
Provides the details of a group's status.
Summary information for groups.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
Information about the IAM Identity Center Application used to configure authentication for a plugin.
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.
Details about an image source, including its identifier and format.
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 Business.
A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.
An issue occurred with the internal server used for your Amazon Q Business 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 configuration for extracting information from media in documents.
The requested media object is too large to be returned.
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.
A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.
Configuration information for an Amazon Q Business index.
Information about invoking a custom plugin without any authentication or authorization requirement.
Provides information on boosting NUMBER type document attributes.
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Configuration information required to enable chat orchestration for your Amazon Q Business application.
Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.
Configuration information about chat response personalization. For more information, see Personalizing chat responses.
Authentication configuration information for an Amazon Q Business plugin.
Configuration information required to invoke chat in PLUGIN_MODE.
Summary metadata information for a Amazon Q Business plugin.
Provides information about a group associated with the principal.
Provides information about a user associated with a principal.
Configuration information about Amazon Q Apps.
Base class for all service related exceptions thrown by the QBusiness client
The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.
Represents a piece of content that is relevant to a search query.
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
Configuration settings to define how Amazon Q Business generates and formats responses to user queries. This includes customization options for response style, tone, length, and other characteristics.
Provides information on how the retriever used for your Amazon Q Business application is configured.
Specifies a retriever as the content source for a search.
Provides configuration information about a rule.
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Provides information about the relevance score of content.
You have exceeded the set limits for your Amazon Q Business service.
Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
The documents used to generate an Amazon Q Business web experience response.
Container for details about different types of media sources (image, audio, or video).
Provides information on boosting STRING type document attributes.
Provides information on boosting STRING_LIST type document attributes.
Information about an Amazon Q Business subscription.
The details of an Amazon Q Business subscription.
A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
Provides information about text documents in an index.
An input event for a end user message in an Amazon Q Business web experience.
An output event for an AI-generated response in an Amazon Q Business web experience.
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 Business application.
Provides information about users and group names associated with a topic control rule.
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
The input failed to meet the constraints specified by Amazon Q Business in a specified field.
Configuration settings for video content extraction and processing.
Details about a video source, including its identifier, format, and time information.
Provides information for an Amazon Q Business web experience.
Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.