| AccessConfiguration |
Used to configure access permissions for a document.
|
| AccessConfiguration.Builder |
|
| AccessControl |
A list of principals.
|
| AccessControl.Builder |
|
| AccessDeniedException.Builder |
|
| ActionExecution |
Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
|
| ActionExecution.Builder |
|
| ActionExecutionEvent |
A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming
chat.
|
| ActionExecutionEvent.Builder |
|
| ActionExecutionEvent.BuilderImpl |
|
| ActionExecutionPayloadField |
A user input field in an plugin action execution payload.
|
| ActionExecutionPayloadField.Builder |
|
| ActionPayloadFieldType |
|
| ActionReview |
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming
chat conversation.
|
| ActionReview.Builder |
|
| ActionReviewEvent |
An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming
chat conversation.
|
| ActionReviewEvent.Builder |
|
| ActionReviewEvent.BuilderImpl |
|
| ActionReviewPayloadField |
A user input field in an plugin action review payload.
|
| ActionReviewPayloadField.Builder |
|
| ActionReviewPayloadFieldAllowedValue |
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.
|
| ActionReviewPayloadFieldAllowedValue.Builder |
|
| APISchema |
Contains details about the OpenAPI schema for a custom plugin.
|
| APISchema.Builder |
|
| APISchema.Type |
|
| APISchemaType |
|
| Application |
Summary information for an Amazon Q Business application.
|
| Application.Builder |
|
| ApplicationStatus |
|
| AppliedAttachmentsConfiguration |
Configuration information about the file upload during chat feature for your application.
|
| AppliedAttachmentsConfiguration.Builder |
|
| AppliedCreatorModeConfiguration |
The creator mode specific admin controls configured for an Amazon Q Business application.
|
| AppliedCreatorModeConfiguration.Builder |
|
| AttachmentInput |
A file directly uploaded into a web experience chat.
|
| AttachmentInput.Builder |
|
| AttachmentInputEvent |
A file input event activated by a end user request to upload files into their web experience chat.
|
| AttachmentInputEvent.Builder |
|
| AttachmentInputEvent.BuilderImpl |
|
| AttachmentOutput |
The details of a file uploaded during chat.
|
| AttachmentOutput.Builder |
|
| AttachmentsConfiguration |
Configuration information for the file upload during chat feature.
|
| AttachmentsConfiguration.Builder |
|
| AttachmentsControlMode |
|
| AttachmentStatus |
|
| AttributeFilter |
Enables filtering of responses based on document attributes or metadata fields.
|
| AttributeFilter.Builder |
|
| AttributeType |
|
| AttributeValueOperator |
|
| AuthChallengeRequest |
A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
|
| AuthChallengeRequest.Builder |
|
| AuthChallengeRequestEvent |
An authentication verification event activated by an end user request to use a custom plugin.
|
| AuthChallengeRequestEvent.Builder |
|
| AuthChallengeRequestEvent.BuilderImpl |
|
| AuthChallengeResponse |
Contains details of the authentication information received from a third party authentication server in response to
an authentication challenge.
|
| AuthChallengeResponse.Builder |
|
| AuthChallengeResponseEvent |
An authentication verification event response by a third party authentication server to Amazon Q Business.
|
| AuthChallengeResponseEvent.Builder |
|
| AuthChallengeResponseEvent.BuilderImpl |
|
| BasicAuthConfiguration |
Information about the basic authentication credentials used to configure a plugin.
|
| BasicAuthConfiguration.Builder |
|
| BatchDeleteDocumentRequest.Builder |
|
| BatchDeleteDocumentResponse.Builder |
|
| BatchPutDocumentRequest.Builder |
|
| BatchPutDocumentResponse.Builder |
|
| BlockedPhrasesConfiguration |
Provides information about the phrases blocked from chat by your chat control configuration.
|
| BlockedPhrasesConfiguration.Builder |
|
| BlockedPhrasesConfigurationUpdate |
Updates a blocked phrases configuration in your Amazon Q Business application.
|
| BlockedPhrasesConfigurationUpdate.Builder |
|
| ChatInputStream |
Base interface for all event types in ChatInputStream.
|
| ChatInputStream.EventType |
The known possible types of events for ChatInputStream.
|
| ChatMode |
|
| ChatModeConfiguration |
Configuration information for Amazon Q Business conversation modes.
|
| ChatModeConfiguration.Builder |
|
| ChatModeConfiguration.Type |
|
| ChatOutputStream |
Base interface for all event types in ChatOutputStream.
|
| ChatOutputStream.EventType |
The known possible types of events for ChatOutputStream.
|
| ChatRequest.Builder |
|
| ChatResponse.Builder |
|
| ChatResponseHandler |
Response handler for the Chat API.
|
| ChatResponseHandler.Builder |
|
| ChatResponseHandler.Visitor |
|
| ChatResponseHandler.Visitor.Builder |
|
| ChatSyncRequest.Builder |
|
| ChatSyncResponse.Builder |
|
| ConfigurationEvent |
A configuration event activated by an end user request to select a specific chat mode.
|
| ConfigurationEvent.Builder |
|
| ConfigurationEvent.BuilderImpl |
|
| ConflictException.Builder |
|
| ContentBlockerRule |
A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
|
| ContentBlockerRule.Builder |
|
| ContentRetrievalRule |
Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic
control configuration.
|
| ContentRetrievalRule.Builder |
|
| ContentType |
|
| Conversation |
A conversation in an Amazon Q Business application.
|
| Conversation.Builder |
|
| CreateApplicationRequest.Builder |
|
| CreateApplicationResponse.Builder |
|
| CreateDataSourceRequest.Builder |
|
| CreateDataSourceResponse.Builder |
|
| CreateIndexRequest.Builder |
|
| CreateIndexResponse.Builder |
|
| CreatePluginRequest.Builder |
|
| CreatePluginResponse.Builder |
|
| CreateRetrieverRequest.Builder |
|
| CreateRetrieverResponse.Builder |
|
| CreateUserRequest.Builder |
|
| CreateUserResponse.Builder |
|
| CreateWebExperienceRequest.Builder |
|
| CreateWebExperienceResponse.Builder |
|
| CreatorModeConfiguration |
Configuration information required to invoke chat in CREATOR_MODE.
|
| CreatorModeConfiguration.Builder |
|
| CreatorModeControl |
|
| CustomPluginConfiguration |
Configuration information required to create a custom plugin.
|
| CustomPluginConfiguration.Builder |
|
| DataSource |
A data source in an Amazon Q Business application.
|
| DataSource.Builder |
|
| DataSourceStatus |
|
| DataSourceSyncJob |
Provides information about an Amazon Q Business data source connector synchronization job.
|
| DataSourceSyncJob.Builder |
|
| DataSourceSyncJobMetrics |
Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
|
| DataSourceSyncJobMetrics.Builder |
|
| DataSourceSyncJobStatus |
|
| DataSourceVpcConfiguration |
Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
|
| DataSourceVpcConfiguration.Builder |
|
| DateAttributeBoostingConfiguration |
Provides information on boosting DATE type document attributes.
|
| DateAttributeBoostingConfiguration.Builder |
|
| DeleteApplicationRequest.Builder |
|
| DeleteApplicationResponse.Builder |
|
| DeleteChatControlsConfigurationRequest.Builder |
|
| DeleteChatControlsConfigurationResponse.Builder |
|
| DeleteConversationRequest.Builder |
|
| DeleteConversationResponse.Builder |
|
| DeleteDataSourceRequest.Builder |
|
| DeleteDataSourceResponse.Builder |
|
| DeleteDocument |
A document deleted from an Amazon Q Business data source connector.
|
| DeleteDocument.Builder |
|
| DeleteGroupRequest.Builder |
|
| DeleteGroupResponse.Builder |
|
| DeleteIndexRequest.Builder |
|
| DeleteIndexResponse.Builder |
|
| DeletePluginRequest.Builder |
|
| DeletePluginResponse.Builder |
|
| DeleteRetrieverRequest.Builder |
|
| DeleteRetrieverResponse.Builder |
|
| DeleteUserRequest.Builder |
|
| DeleteUserResponse.Builder |
|
| DeleteWebExperienceRequest.Builder |
|
| DeleteWebExperienceResponse.Builder |
|
| Document |
A document in an Amazon Q Business application.
|
| Document.Builder |
|
| DocumentAttribute |
A document attribute or metadata field.
|
| DocumentAttribute.Builder |
|
| DocumentAttributeBoostingConfiguration |
Provides information on boosting supported Amazon Q Business document attribute types.
|
| DocumentAttributeBoostingConfiguration.Builder |
|
| DocumentAttributeBoostingConfiguration.Type |
|
| DocumentAttributeBoostingLevel |
|
| DocumentAttributeCondition |
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q
Business.
|
| DocumentAttributeCondition.Builder |
|
| DocumentAttributeConfiguration |
Configuration information for document attributes.
|
| DocumentAttributeConfiguration.Builder |
|
| DocumentAttributeTarget |
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
|
| DocumentAttributeTarget.Builder |
|
| DocumentAttributeValue |
The value of a document attribute.
|
| DocumentAttributeValue.Builder |
|
| DocumentAttributeValue.Type |
|
| DocumentContent |
The contents of a document.
|
| DocumentContent.Builder |
|
| DocumentContent.Type |
|
| DocumentContentOperator |
|
| DocumentDetails |
The details of a document within an Amazon Q Business index.
|
| DocumentDetails.Builder |
|
| DocumentEnrichmentConditionOperator |
|
| DocumentEnrichmentConfiguration |
Provides the configuration information for altering document metadata and content during the document ingestion
process.
|
| DocumentEnrichmentConfiguration.Builder |
|
| DocumentStatus |
|
| EligibleDataSource |
The identifier of the data source Amazon Q Business will generate responses from.
|
| EligibleDataSource.Builder |
|
| EncryptionConfiguration |
Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business.
|
| EncryptionConfiguration.Builder |
|
| EndOfInputEvent |
The end of the streaming input for the Chat API.
|
| EndOfInputEvent.Builder |
|
| EndOfInputEvent.BuilderImpl |
|
| ErrorCode |
|
| ErrorDetail |
Provides information about a data source sync error.
|
| ErrorDetail.Builder |
|
| FailedAttachmentEvent |
A failed file upload during web experience chat.
|
| FailedAttachmentEvent.Builder |
|
| FailedAttachmentEvent.BuilderImpl |
|
| FailedDocument |
A list of documents that could not be removed from an Amazon Q Business index.
|
| FailedDocument.Builder |
|
| GetApplicationRequest.Builder |
|
| GetApplicationResponse.Builder |
|
| GetChatControlsConfigurationRequest.Builder |
|
| GetChatControlsConfigurationResponse.Builder |
|
| GetDataSourceRequest.Builder |
|
| GetDataSourceResponse.Builder |
|
| GetGroupRequest.Builder |
|
| GetGroupResponse.Builder |
|
| GetIndexRequest.Builder |
|
| GetIndexResponse.Builder |
|
| GetPluginRequest.Builder |
|
| GetPluginResponse.Builder |
|
| GetRetrieverRequest.Builder |
|
| GetRetrieverResponse.Builder |
|
| GetUserRequest.Builder |
|
| GetUserResponse.Builder |
|
| GetWebExperienceRequest.Builder |
|
| GetWebExperienceResponse.Builder |
|
| GroupMembers |
A list of users or sub groups that belong to a group.
|
| GroupMembers.Builder |
|
| GroupStatus |
|
| GroupStatusDetail |
Provides the details of a group's status.
|
| GroupStatusDetail.Builder |
|
| GroupSummary |
Summary information for groups.
|
| GroupSummary.Builder |
|
| HookConfiguration |
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and
content when ingesting documents into Amazon Q Business.
|
| HookConfiguration.Builder |
|
| Index |
Summary information for your Amazon Q Business index.
|
| Index.Builder |
|
| IndexCapacityConfiguration |
Provides information about index capacity configuration.
|
| IndexCapacityConfiguration.Builder |
|
| IndexStatistics |
Provides information about the number of documents in an index.
|
| IndexStatistics.Builder |
|
| IndexStatus |
|
| IndexType |
|
| InlineDocumentEnrichmentConfiguration |
Provides the configuration information for applying basic logic to alter document metadata and content when ingesting
documents into Amazon Q Business.
|
| InlineDocumentEnrichmentConfiguration.Builder |
|
| InternalServerException.Builder |
|
| KendraIndexConfiguration |
Stores an Amazon Kendra index as a retriever.
|
| KendraIndexConfiguration.Builder |
|
| LicenseNotFoundException.Builder |
|
| ListApplicationsRequest.Builder |
|
| ListApplicationsResponse.Builder |
|
| ListConversationsRequest.Builder |
|
| ListConversationsResponse.Builder |
|
| ListDataSourcesRequest.Builder |
|
| ListDataSourcesResponse.Builder |
|
| ListDataSourceSyncJobsRequest.Builder |
|
| ListDataSourceSyncJobsResponse.Builder |
|
| ListDocumentsRequest.Builder |
|
| ListDocumentsResponse.Builder |
|
| ListGroupsRequest.Builder |
|
| ListGroupsResponse.Builder |
|
| ListIndicesRequest.Builder |
|
| ListIndicesResponse.Builder |
|
| ListMessagesRequest.Builder |
|
| ListMessagesResponse.Builder |
|
| ListPluginsRequest.Builder |
|
| ListPluginsResponse.Builder |
|
| ListRetrieversRequest.Builder |
|
| ListRetrieversResponse.Builder |
|
| ListTagsForResourceRequest.Builder |
|
| ListTagsForResourceResponse.Builder |
|
| ListWebExperiencesRequest.Builder |
|
| ListWebExperiencesResponse.Builder |
|
| MemberGroup |
The sub groups that belong to a group.
|
| MemberGroup.Builder |
|
| MemberRelation |
|
| MembershipType |
|
| MemberUser |
The users that belong to a group.
|
| MemberUser.Builder |
|
| Message |
A message in an Amazon Q Business web experience.
|
| Message.Builder |
|
| MessageType |
|
| MessageUsefulness |
|
| MessageUsefulnessFeedback |
End user feedback on an AI-generated web experience chat message usefulness.
|
| MessageUsefulnessFeedback.Builder |
|
| MessageUsefulnessReason |
|
| MetadataEvent |
A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated
metadata generated.
|
| MetadataEvent.Builder |
|
| MetadataEvent.BuilderImpl |
|
| NativeIndexConfiguration |
Configuration information for an Amazon Q Business index.
|
| NativeIndexConfiguration.Builder |
|
| NoAuthConfiguration |
Information about invoking a custom plugin without any authentication or authorization requirement.
|
| NoAuthConfiguration.Builder |
|
| NumberAttributeBoostingConfiguration |
Provides information on boosting NUMBER type document attributes.
|
| NumberAttributeBoostingConfiguration.Builder |
|
| NumberAttributeBoostingType |
|
| OAuth2ClientCredentialConfiguration |
Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
|
| OAuth2ClientCredentialConfiguration.Builder |
|
| PersonalizationConfiguration |
Configuration information about chat response personalization.
|
| PersonalizationConfiguration.Builder |
|
| PersonalizationControlMode |
|
| Plugin |
Information about an Amazon Q Business plugin and its configuration.
|
| Plugin.Builder |
|
| PluginAuthConfiguration |
Authentication configuration information for an Amazon Q Business plugin.
|
| PluginAuthConfiguration.Builder |
|
| PluginAuthConfiguration.Type |
|
| PluginBuildStatus |
|
| PluginConfiguration |
Configuration information required to invoke chat in PLUGIN_MODE.
|
| PluginConfiguration.Builder |
|
| PluginState |
|
| PluginType |
|
| Principal |
Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation
responses.
|
| Principal.Builder |
|
| Principal.Type |
|
| PrincipalGroup |
Provides information about a group associated with the principal.
|
| PrincipalGroup.Builder |
|
| PrincipalUser |
Provides information about a user associated with a principal.
|
| PrincipalUser.Builder |
|
| PutFeedbackRequest.Builder |
|
| PutFeedbackResponse.Builder |
|
| PutGroupRequest.Builder |
|
| PutGroupResponse.Builder |
|
| QAppsConfiguration |
Configuration information about Amazon Q Apps.
|
| QAppsConfiguration.Builder |
|
| QAppsControlMode |
|
| QBusinessException |
|
| QBusinessException.Builder |
|
| QBusinessException.BuilderImpl |
|
| QBusinessRequest |
|
| QBusinessRequest.Builder |
|
| QBusinessResponse |
|
| QBusinessResponse.Builder |
|
| QBusinessResponseMetadata |
|
| ReadAccessType |
|
| ResourceNotFoundException.Builder |
|
| ResponseScope |
|
| Retriever |
Summary information for the retriever used for your Amazon Q Business application.
|
| Retriever.Builder |
|
| RetrieverConfiguration |
Provides information on how the retriever used for your Amazon Q Business application is configured.
|
| RetrieverConfiguration.Builder |
|
| RetrieverConfiguration.Type |
|
| RetrieverStatus |
|
| RetrieverType |
|
| Rule |
Guardrail rules for an Amazon Q Business application.
|
| Rule.Builder |
|
| RuleConfiguration |
Provides configuration information about a rule.
|
| RuleConfiguration.Builder |
|
| RuleConfiguration.Type |
|
| RuleType |
|
| S3 |
Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
|
| S3.Builder |
|
| SamlConfiguration |
Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a
Amazon Q Business web experience.
|
| SamlConfiguration.Builder |
|
| ServiceQuotaExceededException.Builder |
|
| SnippetExcerpt |
Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q
Business chat response.
|
| SnippetExcerpt.Builder |
|
| SourceAttribution |
The documents used to generate an Amazon Q Business web experience response.
|
| SourceAttribution.Builder |
|
| StartDataSourceSyncJobRequest.Builder |
|
| StartDataSourceSyncJobResponse.Builder |
|
| Status |
|
| StopDataSourceSyncJobRequest.Builder |
|
| StopDataSourceSyncJobResponse.Builder |
|
| StringAttributeBoostingConfiguration |
Provides information on boosting STRING type document attributes.
|
| StringAttributeBoostingConfiguration.Builder |
|
| StringAttributeValueBoostingLevel |
|
| StringListAttributeBoostingConfiguration |
Provides information on boosting STRING_LIST type document attributes.
|
| StringListAttributeBoostingConfiguration.Builder |
|
| Tag |
A list of key/value pairs that identify an index, FAQ, or data source.
|
| Tag.Builder |
|
| TagResourceRequest.Builder |
|
| TagResourceResponse.Builder |
|
| TextDocumentStatistics |
Provides information about text documents in an index.
|
| TextDocumentStatistics.Builder |
|
| TextInputEvent |
An input event for a end user message in an Amazon Q Business web experience.
|
| TextInputEvent.Builder |
|
| TextInputEvent.BuilderImpl |
|
| TextOutputEvent |
An output event for an AI-generated response in an Amazon Q Business web experience.
|
| TextOutputEvent.Builder |
|
| TextOutputEvent.BuilderImpl |
|
| TextSegment |
Provides information about a text extract in a chat response that can be attributed to a source document.
|
| TextSegment.Builder |
|
| ThrottlingException.Builder |
|
| TopicConfiguration |
The topic specific controls configured for an Amazon Q Business application.
|
| TopicConfiguration.Builder |
|
| UntagResourceRequest.Builder |
|
| UntagResourceResponse.Builder |
|
| UpdateApplicationRequest.Builder |
|
| UpdateApplicationResponse.Builder |
|
| UpdateChatControlsConfigurationRequest.Builder |
|
| UpdateChatControlsConfigurationResponse.Builder |
|
| UpdateDataSourceRequest.Builder |
|
| UpdateDataSourceResponse.Builder |
|
| UpdateIndexRequest.Builder |
|
| UpdateIndexResponse.Builder |
|
| UpdatePluginRequest.Builder |
|
| UpdatePluginResponse.Builder |
|
| UpdateRetrieverRequest.Builder |
|
| UpdateRetrieverResponse.Builder |
|
| UpdateUserRequest.Builder |
|
| UpdateUserResponse.Builder |
|
| UpdateWebExperienceRequest.Builder |
|
| UpdateWebExperienceResponse.Builder |
|
| UserAlias |
Aliases attached to a user id within an Amazon Q Business application.
|
| UserAlias.Builder |
|
| UsersAndGroups |
Provides information about users and groups associated with a topic control rule.
|
| UsersAndGroups.Builder |
|
| ValidationException.Builder |
|
| ValidationExceptionField |
The input failed to meet the constraints specified by Amazon Q Business in a specified field.
|
| ValidationExceptionField.Builder |
|
| ValidationExceptionReason |
|
| WebExperience |
Provides information for an Amazon Q Business web experience.
|
| WebExperience.Builder |
|
| WebExperienceAuthConfiguration |
Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end
users.
|
| WebExperienceAuthConfiguration.Builder |
|
| WebExperienceAuthConfiguration.Type |
|
| WebExperienceSamplePromptsControlMode |
|
| WebExperienceStatus |
|