# Constants
Enum values for ActionPayloadFieldType.
Enum values for ActionPayloadFieldType.
Enum values for ActionPayloadFieldType.
Enum values for ActionPayloadFieldType.
Enum values for APISchemaType.
Enum values for ApplicationStatus.
Enum values for ApplicationStatus.
Enum values for ApplicationStatus.
Enum values for ApplicationStatus.
Enum values for ApplicationStatus.
Enum values for AttachmentsControlMode.
Enum values for AttachmentsControlMode.
Enum values for AttachmentStatus.
Enum values for AttachmentStatus.
Enum values for AttributeType.
Enum values for AttributeType.
Enum values for AttributeType.
Enum values for AttributeType.
Enum values for AttributeValueOperator.
Enum values for AudioExtractionStatus.
Enum values for AudioExtractionStatus.
Enum values for AudioExtractionType.
Enum values for AudioExtractionType.
Enum values for AutoSubscriptionStatus.
Enum values for AutoSubscriptionStatus.
Enum values for BrowserExtension.
Enum values for BrowserExtension.
Enum values for ChatMode.
Enum values for ChatMode.
Enum values for ChatMode.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for ContentType.
Enum values for CreatorModeControl.
Enum values for CreatorModeControl.
Enum values for DataSourceStatus.
Enum values for DataSourceStatus.
Enum values for DataSourceStatus.
Enum values for DataSourceStatus.
Enum values for DataSourceStatus.
Enum values for DataSourceStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DataSourceSyncJobStatus.
Enum values for DocumentAttributeBoostingLevel.
Enum values for DocumentAttributeBoostingLevel.
Enum values for DocumentAttributeBoostingLevel.
Enum values for DocumentAttributeBoostingLevel.
Enum values for DocumentAttributeBoostingLevel.
Enum values for DocumentContentOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentEnrichmentConditionOperator.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for DocumentStatus.
Enum values for ErrorCode.
Enum values for ErrorCode.
Enum values for ErrorCode.
Enum values for ErrorCode.
Enum values for GroupStatus.
Enum values for GroupStatus.
Enum values for GroupStatus.
Enum values for GroupStatus.
Enum values for GroupStatus.
Enum values for IdentityType.
Enum values for IdentityType.
Enum values for IdentityType.
Enum values for IdentityType.
Enum values for ImageExtractionStatus.
Enum values for ImageExtractionStatus.
Enum values for IndexStatus.
Enum values for IndexStatus.
Enum values for IndexStatus.
Enum values for IndexStatus.
Enum values for IndexStatus.
Enum values for IndexType.
Enum values for IndexType.
Enum values for MemberRelation.
Enum values for MemberRelation.
Enum values for MembershipType.
Enum values for MembershipType.
Enum values for MessageType.
Enum values for MessageType.
Enum values for MessageUsefulness.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulnessReason.
Enum values for MessageUsefulness.
Enum values for NumberAttributeBoostingType.
Enum values for NumberAttributeBoostingType.
Enum values for OrchestrationControl.
Enum values for OrchestrationControl.
Enum values for PersonalizationControlMode.
Enum values for PersonalizationControlMode.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginBuildStatus.
Enum values for PluginState.
Enum values for PluginState.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginTypeCategory.
Enum values for PluginTypeCategory.
Enum values for PluginTypeCategory.
Enum values for PluginTypeCategory.
Enum values for PluginTypeCategory.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for PluginType.
Enum values for QAppsControlMode.
Enum values for QAppsControlMode.
Enum values for ReadAccessType.
Enum values for ReadAccessType.
Enum values for ResponseScope.
Enum values for ResponseScope.
Enum values for RetrieverStatus.
Enum values for RetrieverStatus.
Enum values for RetrieverStatus.
Enum values for RetrieverType.
Enum values for RetrieverType.
Enum values for RuleType.
Enum values for RuleType.
Enum values for ScoreConfidence.
Enum values for ScoreConfidence.
Enum values for ScoreConfidence.
Enum values for ScoreConfidence.
Enum values for ScoreConfidence.
Enum values for Status.
Enum values for Status.
Enum values for StringAttributeValueBoostingLevel.
Enum values for StringAttributeValueBoostingLevel.
Enum values for StringAttributeValueBoostingLevel.
Enum values for StringAttributeValueBoostingLevel.
Enum values for SubscriptionType.
Enum values for SubscriptionType.
Enum values for ValidationExceptionReason.
Enum values for ValidationExceptionReason.
Enum values for ValidationExceptionReason.
Enum values for VideoExtractionStatus.
Enum values for VideoExtractionStatus.
Enum values for VideoExtractionType.
Enum values for VideoExtractionType.
Enum values for WebExperienceSamplePromptsControlMode.
Enum values for WebExperienceSamplePromptsControlMode.
Enum values for WebExperienceStatus.
Enum values for WebExperienceStatus.
Enum values for WebExperienceStatus.
Enum values for WebExperienceStatus.
Enum values for WebExperienceStatus.
# Structs
Used to configure access permissions for a document.
A list of principals.
You don't have access to perform this action.
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.
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation.
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.
The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
Contains details about the S3 object containing the OpenAPI schema for a custom plugin.
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.
The chat orchestration specific admin controls configured for an Amazon Q Business application.
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.
A request from an end user to perform an Amazon Q Business plugin action.
A request by an end user to upload a file during chat.
An authentication verification event response by a third party authentication server to Amazon Q Business.
A configuration event activated by an end user request to select a specific chat mode.
The end of the streaming input for the Chat API.
Information about the payload of the ChatInputStream event containing the end user message input.
Configuration information required to invoke chat in PLUGIN_MODE .
A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
An authentication verification event activated by an end user request to use a custom plugin.
A failed file upload event during a web experience chat.
A metadata event for a AI-generated text output message in a Amazon Q Business conversation.
Information about the payload of the ChatOutputStream event containing the AI-generated message output.
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.
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
The retriever to use as the content source.
A conversation in an Amazon Q Business application.
The source reference for an existing attachment in an existing conversation.
A reference to an attachment in an existing conversation.
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 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.
A document in an Amazon Q Business application.
A document attribute or metadata field.
Provides information on boosting DATE type document attributes.
Provides information on boosting NUMBER type document attributes.
Provides information on boosting STRING type document attributes.
Provides information on boosting STRING_LIST type document attributes.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.
Configuration information for document attributes.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
A date expressed as an ISO 8601 string.
A long integer value.
A list of strings.
A string.
The contents of the document.
The path to the document in an Amazon S3 bucket.
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.
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.
A failed file upload during web experience chat.
A list of documents that could not be removed from an Amazon Q Business index.
A list of users or sub groups that belong to a group.
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 Business.
Information about the IAM Identity Center Application used to configure authentication for a plugin.
Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an 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.
The configuration for extracting semantic meaning from images in documents.
Details about an image source, including its identifier and format.
Summary information for your Amazon Q Business index.
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.
An issue occurred with the internal server used for your Amazon Q Business service.
Stores an Amazon Kendra index as a retriever.
You don't have permissions to perform the action because your license is inactive.
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.
A message in an Amazon Q Business web experience.
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.
Configuration information about chat response personalization.
Information about an Amazon Q Business plugin and its configuration.
Information about the basic authentication credentials used to configure a plugin.
Information about the IAM Identity Center Application used to configure authentication for a plugin.
Information about invoking a custom plugin without any authentication.
Information about the OAuth 2.0 authentication credential/token used to configure a 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.
The group associated with the principal.
The user associated with the principal.
Provides information about a user associated with a principal.
Configuration information about Amazon Q Apps.
The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
Represents a piece of content that is relevant to a search query.
The application or plugin resource you want to use doesn’t exist.
Summary information for the retriever used for your Amazon Q Business application.
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
Specifies a retriever as the content source for a search.
Guardrail rules for an Amazon Q Business application.
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
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.
Details specific to audio content within the source.
Details specific to image content within the source.
Details specific to video content within the source.
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.
The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.
The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.
A list of key/value pairs that identify an index, FAQ, or data source.
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.
The topic specific controls configured for an Amazon Q Business application.
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
Aliases attached to a user id within 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.
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 SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
# Interfaces
Contains details about the OpenAPI schema for a custom plugin.
The streaming input for the Chat API.
Configuration information for Amazon Q Business conversation modes.
The streaming output for the Chat API.
Specifies the source of content to search in.
The source reference for an existing attachment.
Provides information on boosting supported Amazon Q Business document attribute types.
The value of a document attribute.
The contents of a document.
Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Authentication configuration information for an Amazon Q Business plugin.
Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
Provides information on how the retriever used for your Amazon Q Business application is configured.
Provides configuration information about a rule.
Container for details about different types of media sources (image, audio, or video).
A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author