This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
The following resources provide additional information about using the Amazon Q Business API:
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
", "BatchDeleteDocument": "Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
", "BatchPutDocument": "Adds one or more documents to an Amazon Q Business index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
add custom attributes to documents in an Amazon Q Business index.
attach an access control list to the documents added to an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
", "CancelSubscription": "Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.
", "Chat": "Starts or continues a streaming Amazon Q Business conversation.
", "ChatSync": "Starts or continues a non-streaming Amazon Q Business conversation.
", "CheckDocumentAccess": "Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.
", "CreateAnonymousWebExperienceUrl": "Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
", "CreateApplication": "Creates an Amazon Q Business application.
There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users.
An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see Cross region inference in Amazon Q Business.
Creates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.
", "CreateDataAccessor": "Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
", "CreateDataSource": "Creates a data source connector for an Amazon Q Business application.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Creates an Amazon Q Business index.
To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.
Creates an Amazon Q Business plugin.
", "CreateRetriever": "Adds a retriever to your Amazon Q Business application.
", "CreateSubscription": "Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.
Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.
Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
", "CreateWebExperience": "Creates an Amazon Q Business web experience.
", "DeleteApplication": "Deletes an Amazon Q Business application.
", "DeleteAttachment": "Deletes an attachment associated with a specific Amazon Q Business conversation.
", "DeleteChatControlsConfiguration": "Deletes chat controls configured for an existing Amazon Q Business application.
", "DeleteChatResponseConfiguration": "Deletes a specified chat response configuration from an Amazon Q Business application.
", "DeleteConversation": "Deletes an Amazon Q Business web experience conversation.
", "DeleteDataAccessor": "Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.
", "DeleteDataSource": "Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their chat results.
If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutGroup.
Deletes an Amazon Q Business index.
", "DeletePlugin": "Deletes an Amazon Q Business plugin.
", "DeleteRetriever": "Deletes the retriever used by an Amazon Q Business application.
", "DeleteUser": "Deletes a user by email id.
", "DeleteWebExperience": "Deletes an Amazon Q Business web experience.
", "DisassociatePermission": "Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.
", "GetApplication": "Gets information about an existing Amazon Q Business application.
", "GetChatControlsConfiguration": "Gets information about chat controls configured for an existing Amazon Q Business application.
", "GetChatResponseConfiguration": "Retrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.
", "GetDataAccessor": "Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
", "GetDataSource": "Gets information about an existing Amazon Q Business data source connector.
", "GetDocumentContent": "Retrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.
", "GetGroup": "Describes a group by group name.
", "GetIndex": "Gets information about an existing Amazon Q Business index.
", "GetMedia": "Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.
For more information, see Extracting semantic meaning from images and visuals.
", "GetPlugin": "Gets information about an existing Amazon Q Business plugin.
", "GetPolicy": "Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.
", "GetRetriever": "Gets information about an existing retriever used by an Amazon Q Business application.
", "GetUser": "Describes the universally unique identifier (UUID) associated with a local user in a data source.
", "GetWebExperience": "Gets information about an existing Amazon Q Business web experience.
", "ListApplications": "Lists Amazon Q Business applications.
Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.
", "ListChatResponseConfigurations": "Retrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.
", "ListConversations": "Lists one or more Amazon Q Business conversations.
", "ListDataAccessors": "Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
", "ListDataSourceSyncJobs": "Get information about an Amazon Q Business data source connector synchronization.
", "ListDataSources": "Lists the Amazon Q Business data source connectors that you have created.
", "ListDocuments": "A list of documents attached to an index.
", "ListGroups": "Provides a list of groups that are mapped to users.
", "ListIndices": "Lists the Amazon Q Business indices you have created.
", "ListMessages": "Gets a list of messages associated with an Amazon Q Business web experience.
", "ListPluginActions": "Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.
", "ListPluginTypeActions": "Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.
", "ListPluginTypeMetadata": "Lists metadata for all Amazon Q Business plugin types.
", "ListPlugins": "Lists configured Amazon Q Business plugins.
", "ListRetrievers": "Lists the retriever used by an Amazon Q Business application.
", "ListSubscriptions": "Lists all subscriptions created in an Amazon Q Business application.
", "ListTagsForResource": "Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
", "ListWebExperiences": "Lists one or more Amazon Q Business Web Experiences.
", "PutFeedback": "Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
", "PutGroup": "Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.
There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a RoleArn for Amazon Q Buisness to access the file.
Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.
", "StartDataSourceSyncJob": "Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.
Stops an Amazon Q Business data source connector synchronization job already in progress.
", "TagResource": "Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
", "UntagResource": "Removes a tag from an Amazon Q Business application or a data source.
", "UpdateApplication": "Updates an existing Amazon Q Business application.
Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.
An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.
Updates a set of chat controls configured for an existing Amazon Q Business application.
", "UpdateChatResponseConfiguration": "Updates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.
", "UpdateDataAccessor": "Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
", "UpdateDataSource": "Updates an existing Amazon Q Business data source connector.
", "UpdateIndex": "Updates an Amazon Q Business index.
", "UpdatePlugin": "Updates an Amazon Q Business plugin.
", "UpdateRetriever": "Updates the retriever used for your Amazon Q Business application.
", "UpdateSubscription": "Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
", "UpdateUser": "Updates a information associated with a user id.
", "UpdateWebExperience": "Updates an Amazon Q Business web experience.
" }, "shapes": { "APISchema": { "base": "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.
Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
" } }, "APISchemaType": { "base": null, "refs": { "CustomPluginConfiguration$apiSchemaType": "The type of OpenAPI schema to use.
" } }, "AccessConfiguration": { "base": "Used to configure access permissions for a document.
", "refs": { "Document$accessConfiguration": "Configuration information for access permission to a document.
" } }, "AccessControl": { "base": "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.
A list of AccessControlList objects.
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
", "refs": { } }, "ActionConfiguration": { "base": "Specifies an allowed action and its associated filter configuration.
", "refs": { "ActionConfigurationList$member": null } }, "ActionConfigurationList": { "base": null, "refs": { "CreateDataAccessorRequest$actionConfigurations": "A list of action configurations specifying the allowed actions and any associated filters.
", "GetDataAccessorResponse$actionConfigurations": "The list of action configurations specifying the allowed actions and any associated filters.
", "UpdateDataAccessorRequest$actionConfigurations": "The updated list of action configurations specifying the allowed actions and any associated filters.
" } }, "ActionExecution": { "base": "Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
", "refs": { "ChatSyncInput$actionExecution": "A request from an end user to perform an Amazon Q Business plugin action.
", "Message$actionExecution": null } }, "ActionExecutionEvent": { "base": "A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.
", "refs": { "ChatInputStream$actionExecutionEvent": "A request from an end user to perform an Amazon Q Business plugin action.
" } }, "ActionExecutionPayload": { "base": null, "refs": { "ActionExecution$payload": "A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
", "ActionExecutionEvent$payload": "A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
" } }, "ActionExecutionPayloadField": { "base": "A user input field in an plugin action execution payload.
", "refs": { "ActionExecutionPayload$value": null } }, "ActionFilterConfiguration": { "base": "Specifies filters to apply to an allowed action.
", "refs": { "ActionConfiguration$filterConfiguration": "The filter configuration for the action, if any.
" } }, "ActionPayloadFieldKey": { "base": null, "refs": { "ActionExecutionPayload$key": null, "ActionReviewPayload$key": null } }, "ActionPayloadFieldNameSeparator": { "base": null, "refs": { "ActionExecution$payloadFieldNameSeparator": "A string used to retain information about the hierarchical contexts within an action execution event payload.
", "ActionExecutionEvent$payloadFieldNameSeparator": "A string used to retain information about the hierarchical contexts within a action execution event payload.
", "ActionReview$payloadFieldNameSeparator": "A string used to retain information about the hierarchical contexts within an action review payload.
", "ActionReviewEvent$payloadFieldNameSeparator": "A string used to retain information about the hierarchical contexts within an action review event payload.
" } }, "ActionPayloadFieldType": { "base": null, "refs": { "ActionReviewPayloadField$type": "The type of field.
" } }, "ActionPayloadFieldValue": { "base": null, "refs": { "ActionExecutionPayloadField$value": "The content of a user input field in an plugin action execution payload.
", "ActionReviewPayloadField$value": "The field value.
", "ActionReviewPayloadFieldAllowedValue$value": "The field value.
", "ActionReviewPayloadFieldAllowedValue$displayValue": "The name of the field.
" } }, "ActionReview": { "base": "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.
", "refs": { "ChatSyncOutput$actionReview": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
", "Message$actionReview": null } }, "ActionReviewEvent": { "base": "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.
", "refs": { "ChatOutputStream$actionReviewEvent": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
" } }, "ActionReviewPayload": { "base": null, "refs": { "ActionReview$payload": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
", "ActionReviewEvent$payload": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "ActionReviewPayloadField": { "base": "A user input field in an plugin action review payload.
", "refs": { "ActionReviewPayload$value": null } }, "ActionReviewPayloadFieldAllowedValue": { "base": "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.
", "refs": { "ActionReviewPayloadFieldAllowedValues$member": null } }, "ActionReviewPayloadFieldAllowedValues": { "base": null, "refs": { "ActionReviewPayloadField$allowedValues": "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.
" } }, "ActionReviewPayloadFieldArrayItemJsonSchema": { "base": null, "refs": { "ActionReviewPayloadField$arrayItemJsonSchema": "Use to create a custom form with array fields (fields with nested objects inside an array).
" } }, "ActionSummary": { "base": "Summary information for an Amazon Q Business plugin action.
", "refs": { "Actions$member": null } }, "Actions": { "base": null, "refs": { "ListPluginActionsResponse$items": "An array of information on one or more plugin actions.
", "ListPluginTypeActionsResponse$items": "An array of information on one or more plugins.
" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
", "TagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
", "UntagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
" } }, "Application": { "base": "Summary information for an Amazon Q Business application.
", "refs": { "Applications$member": null } }, "ApplicationArn": { "base": null, "refs": { "CreateApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
", "GetApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" } }, "ApplicationId": { "base": null, "refs": { "Application$applicationId": "The identifier for the Amazon Q Business application.
", "AssociatePermissionRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "BatchDeleteDocumentRequest$applicationId": "The identifier of the Amazon Q Business application.
", "BatchPutDocumentRequest$applicationId": "The identifier of the Amazon Q Business application.
", "CancelSubscriptionRequest$applicationId": "The identifier of the Amazon Q Business application for which the subscription is being cancelled.
", "ChatInput$applicationId": "The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
", "ChatSyncInput$applicationId": "The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
", "CheckDocumentAccessRequest$applicationId": "The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.
", "CreateAnonymousWebExperienceUrlRequest$applicationId": "The identifier of the Amazon Q Business application environment attached to the web experience.
", "CreateApplicationResponse$applicationId": "The identifier of the Amazon Q Business application.
", "CreateChatResponseConfigurationRequest$applicationId": "The unique identifier of the Amazon Q Business application for which to create the new chat response configuration.
", "CreateDataAccessorRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "CreateDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application the data source will be attached to.
", "CreateIndexRequest$applicationId": "The identifier of the Amazon Q Business application using the index.
", "CreatePluginRequest$applicationId": "The identifier of the application that will contain the plugin.
", "CreateRetrieverRequest$applicationId": "The identifier of your Amazon Q Business application.
", "CreateSubscriptionRequest$applicationId": "The identifier of the Amazon Q Business application the subscription should be added to.
", "CreateUserRequest$applicationId": "The identifier of the application for which the user mapping will be created.
", "CreateWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business web experience.
", "DeleteApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", "DeleteAttachmentRequest$applicationId": "The unique identifier for the Amazon Q Business application environment.
", "DeleteChatControlsConfigurationRequest$applicationId": "The identifier of the application the chat controls have been configured for.
", "DeleteChatResponseConfigurationRequest$applicationId": "The unique identifier of theAmazon Q Business application from which to delete the chat response configuration.
", "DeleteConversationRequest$applicationId": "The identifier of the Amazon Q Business application associated with the conversation.
", "DeleteDataAccessorRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "DeleteDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application used with the data source connector.
", "DeleteGroupRequest$applicationId": "The identifier of the application in which the group mapping belongs.
", "DeleteIndexRequest$applicationId": "The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
", "DeletePluginRequest$applicationId": "The identifier the application attached to the Amazon Q Business plugin.
", "DeleteRetrieverRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "DeleteUserRequest$applicationId": "The identifier of the application from which the user is being deleted.
", "DeleteWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
", "DisassociatePermissionRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "GetApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", "GetApplicationResponse$applicationId": "The identifier of the Amazon Q Business application.
", "GetChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", "GetChatResponseConfigurationRequest$applicationId": "The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.
", "GetDataAccessorRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "GetDataAccessorResponse$applicationId": "The unique identifier of the Amazon Q Business application associated with this data accessor.
", "GetDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application.
", "GetDataSourceResponse$applicationId": "The identifier of the Amazon Q Business application.
", "GetDocumentContentRequest$applicationId": "The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.
", "GetGroupRequest$applicationId": "The identifier of the application id the group is attached to.
", "GetIndexRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", "GetIndexResponse$applicationId": "The identifier of the Amazon Q Business application associated with the index.
", "GetMediaRequest$applicationId": "The identifier of the Amazon Q Business which contains the media object.
", "GetPluginRequest$applicationId": "The identifier of the application which contains the plugin.
", "GetPluginResponse$applicationId": "The identifier of the application which contains the plugin.
", "GetPolicyRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "GetRetrieverRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "GetRetrieverResponse$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "GetUserRequest$applicationId": "The identifier of the application connected to the user.
", "GetWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application linked to the web experience.
", "GetWebExperienceResponse$applicationId": "The identifier of the Amazon Q Business application linked to the web experience.
", "ListAttachmentsRequest$applicationId": "The unique identifier for the Amazon Q Business application.
", "ListChatResponseConfigurationsRequest$applicationId": "The unique identifier of the Amazon Q Business application for which to list available chat response configurations.
", "ListConversationsRequest$applicationId": "The identifier of the Amazon Q Business application.
", "ListDataAccessorsRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "ListDataSourceSyncJobsRequest$applicationId": "The identifier of the Amazon Q Business application connected to the data source.
", "ListDataSourcesRequest$applicationId": "The identifier of the Amazon Q Business application linked to the data source connectors.
", "ListDocumentsRequest$applicationId": "The identifier of the application id the documents are attached to.
", "ListGroupsRequest$applicationId": "The identifier of the application for getting a list of groups mapped to users.
", "ListIndicesRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", "ListMessagesRequest$applicationId": "The identifier for the Amazon Q Business application.
", "ListPluginActionsRequest$applicationId": "The identifier of the Amazon Q Business application the plugin is attached to.
", "ListPluginsRequest$applicationId": "The identifier of the application the plugin is attached to.
", "ListRetrieversRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "ListSubscriptionsRequest$applicationId": "The identifier of the Amazon Q Business application linked to the subscription.
", "ListWebExperiencesRequest$applicationId": "The identifier of the Amazon Q Business application linked to the listed web experiences.
", "PutFeedbackRequest$applicationId": "The identifier of the application associated with the feedback.
", "PutGroupRequest$applicationId": "The identifier of the application in which the user and group mapping belongs.
", "Retriever$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "SearchRelevantContentRequest$applicationId": "The unique identifier of the Amazon Q Business application to search.
", "StartDataSourceSyncJobRequest$applicationId": "The identifier of Amazon Q Business application the data source is connected to.
", "StopDataSourceSyncJobRequest$applicationId": "The identifier of the Amazon Q Business application that the data source is connected to.
", "UpdateApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", "UpdateChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", "UpdateChatResponseConfigurationRequest$applicationId": "The unique identifier of the Amazon Q Business application containing the chat response configuration to update.
", "UpdateDataAccessorRequest$applicationId": "The unique identifier of the Amazon Q Business application.
", "UpdateDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application the data source is attached to.
", "UpdateIndexRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", "UpdatePluginRequest$applicationId": "The identifier of the application the plugin is attached to.
", "UpdateRetrieverRequest$applicationId": "The identifier of your Amazon Q Business application.
", "UpdateSubscriptionRequest$applicationId": "The identifier of the Amazon Q Business application where the subscription update should take effect.
", "UpdateUserRequest$applicationId": "The identifier of the application the user is attached to.
", "UpdateWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application attached to the web experience.
" } }, "ApplicationName": { "base": null, "refs": { "Application$displayName": "The name of the Amazon Q Business application.
", "CreateApplicationRequest$displayName": "A name for the Amazon Q Business application.
", "GetApplicationResponse$displayName": "The name of the Amazon Q Business application.
", "UpdateApplicationRequest$displayName": "A name for the Amazon Q Business application.
", "UpdateIndexRequest$displayName": "The name of the Amazon Q Business index.
" } }, "ApplicationStatus": { "base": null, "refs": { "Application$status": "The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
The status of the Amazon Q Business application.
" } }, "Applications": { "base": null, "refs": { "ListApplicationsResponse$applications": "An array of summary information on the configuration of one or more Amazon Q Business applications.
" } }, "AppliedAttachmentsConfiguration": { "base": "Configuration information about the file upload during chat feature for your application.
", "refs": { "GetApplicationResponse$attachmentsConfiguration": "Settings for whether end users can upload files directly during chat.
" } }, "AppliedCreatorModeConfiguration": { "base": "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.
For more information, see Admin controls and guardrails and Conversation settings.
", "refs": { "GetChatControlsConfigurationResponse$creatorModeConfiguration": "The configuration details for CREATOR_MODE.
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.
For more information, see Chat orchestration settings.
", "refs": { "GetChatControlsConfigurationResponse$orchestrationConfiguration": "The chat response orchestration settings for your application.
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
Represents a group associated with a given user in the access control system.
", "refs": { "AssociatedGroups$member": null } }, "AssociatedGroups": { "base": null, "refs": { "CheckDocumentAccessResponse$userGroups": "An array of groups the user is part of for the specified data source. Each group has a name and type.
" } }, "AssociatedUser": { "base": "Represents an associated user in the access control system.
", "refs": { "AssociatedUsers$member": null } }, "AssociatedUsers": { "base": null, "refs": { "CheckDocumentAccessResponse$userAliases": "An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.
" } }, "Attachment": { "base": "An attachment in an Amazon Q Business conversation.
", "refs": { "AttachmentList$member": null } }, "AttachmentId": { "base": null, "refs": { "Attachment$attachmentId": "The identifier of the Amazon Q Business attachment.
", "AttachmentOutput$attachmentId": "The unique identifier of the Amazon Q Business attachment.
", "ConversationSource$attachmentId": "The unique identifier of the Amazon Q Business attachment.
", "DeleteAttachmentRequest$attachmentId": "The unique identifier for the attachment.
" } }, "AttachmentInput": { "base": "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.
", "refs": { "AttachmentInputEvent$attachment": null, "AttachmentsInput$member": null } }, "AttachmentInputEvent": { "base": "A file input event activated by a end user request to upload files into their web experience chat.
", "refs": { "ChatInputStream$attachmentEvent": "A request by an end user to upload a file during chat.
" } }, "AttachmentList": { "base": null, "refs": { "ListAttachmentsResponse$attachments": "An array of information on one or more attachments.
" } }, "AttachmentName": { "base": null, "refs": { "Attachment$name": "Filename of the Amazon Q Business attachment.
", "AttachmentInput$name": "The filename of the attachment.
", "AttachmentOutput$name": "The name of a file uploaded during chat.
" } }, "AttachmentOutput": { "base": "The details of a file uploaded during chat.
", "refs": { "AttachmentsOutput$member": null, "FailedAttachmentEvent$attachment": null } }, "AttachmentStatus": { "base": null, "refs": { "Attachment$status": "AttachmentStatus of the Amazon Q Business attachment.
", "AttachmentOutput$status": "The status of a file uploaded during chat.
" } }, "AttachmentsConfiguration": { "base": "Configuration information for the file upload during chat feature.
", "refs": { "CreateApplicationRequest$attachmentsConfiguration": "An option to allow end users to upload files directly during chat.
", "UpdateApplicationRequest$attachmentsConfiguration": "An option to allow end users to upload files directly during chat.
" } }, "AttachmentsControlMode": { "base": null, "refs": { "AppliedAttachmentsConfiguration$attachmentsControlMode": "Information about whether file upload during chat functionality is activated for your application.
", "AttachmentsConfiguration$attachmentsControlMode": "Status information about whether file upload functionality is activated or deactivated for your end user.
" } }, "AttachmentsInput": { "base": null, "refs": { "ChatSyncInput$attachments": "A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
" } }, "AttachmentsOutput": { "base": null, "refs": { "ChatSyncOutput$failedAttachments": "A list of files which failed to upload during chat.
", "Message$attachments": "A file directly uploaded into an Amazon Q Business web experience chat.
" } }, "AttributeFilter": { "base": "Enables filtering of responses based on document attributes or metadata fields.
", "refs": { "ActionFilterConfiguration$documentAttributeFilter": null, "AttributeFilter$notFilter": "Performs a logical NOT operation on all supplied filters.
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
", "ConfigurationEvent$attributeFilter": null, "SearchRelevantContentRequest$attributeFilter": null } }, "AttributeFilters": { "base": null, "refs": { "AttributeFilter$andAllFilters": "Performs a logical AND operation on all supplied filters.
Performs a logical OR operation on all supplied filters.
The type of document attribute.
" } }, "AttributeValueOperator": { "base": null, "refs": { "DocumentAttributeTarget$attributeValueOperator": " TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.
Configuration settings for audio content extraction and processing.
", "refs": { "MediaExtractionConfiguration$audioExtractionConfiguration": "Configuration settings for extracting and processing audio content from media files.
" } }, "AudioExtractionStatus": { "base": null, "refs": { "AudioExtractionConfiguration$audioExtractionStatus": "The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.
" } }, "AudioExtractionType": { "base": null, "refs": { "AudioSourceDetails$audioExtractionType": "The type of audio extraction performed on the content.
" } }, "AudioSourceDetails": { "base": "Details about an audio source, including its identifier, format, and time information.
", "refs": { "SourceDetails$audioSourceDetails": "Details specific to audio content within the source.
" } }, "AuthChallengeRequest": { "base": "A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
", "refs": { "ChatSyncOutput$authChallengeRequest": "An authentication verification event activated by an end user request to use a custom plugin.
" } }, "AuthChallengeRequestEvent": { "base": "An authentication verification event activated by an end user request to use a custom plugin.
", "refs": { "ChatOutputStream$authChallengeRequestEvent": "An authentication verification event activated by an end user request to use a custom plugin.
" } }, "AuthChallengeResponse": { "base": "Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.
", "refs": { "ChatSyncInput$authChallengeResponse": "An authentication verification event response by a third party authentication server to Amazon Q Business.
" } }, "AuthChallengeResponseEvent": { "base": "An authentication verification event response by a third party authentication server to Amazon Q Business.
", "refs": { "ChatInputStream$authChallengeResponseEvent": "An authentication verification event response by a third party authentication server to Amazon Q Business.
" } }, "AuthResponseKey": { "base": null, "refs": { "AuthorizationResponseMap$key": null } }, "AuthResponseValue": { "base": null, "refs": { "AuthorizationResponseMap$value": null } }, "AuthorizationResponseMap": { "base": null, "refs": { "AuthChallengeResponse$responseMap": "The mapping of key-value pairs in an authentication challenge response.
", "AuthChallengeResponseEvent$responseMap": "The mapping of key-value pairs in an authentication challenge response.
" } }, "AutoSubscriptionConfiguration": { "base": "Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
", "refs": { "GetApplicationResponse$autoSubscriptionConfiguration": "Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
", "UpdateApplicationRequest$autoSubscriptionConfiguration": "An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
" } }, "AutoSubscriptionStatus": { "base": null, "refs": { "AutoSubscriptionConfiguration$autoSubscribe": "Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
" } }, "BasicAuthConfiguration": { "base": "Information about the basic authentication credentials used to configure a plugin.
", "refs": { "PluginAuthConfiguration$basicAuthConfiguration": "Information about the basic authentication credentials used to configure a plugin.
" } }, "BatchDeleteDocumentRequest": { "base": null, "refs": { } }, "BatchDeleteDocumentResponse": { "base": null, "refs": { } }, "BatchPutDocumentRequest": { "base": null, "refs": { } }, "BatchPutDocumentResponse": { "base": null, "refs": { } }, "Blob": { "base": null, "refs": { "AttachmentInput$data": "The contents of the attachment.
", "DocumentContent$blob": "The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.
The base64-encoded bytes of the media object.
" } }, "BlockedPhrase": { "base": null, "refs": { "BlockedPhrases$member": null } }, "BlockedPhrases": { "base": null, "refs": { "BlockedPhrasesConfiguration$blockedPhrases": "A list of phrases blocked from a Amazon Q Business web experience chat.
Each phrase can contain a maximum of 36 characters. The list can contain a maximum of 20 phrases.
Creates or updates a blocked phrases configuration in your Amazon Q Business application.
", "BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete": "Deletes a blocked phrases configuration in your Amazon Q Business application.
" } }, "BlockedPhrasesConfiguration": { "base": "Provides information about the phrases blocked from chat by your chat control configuration.
", "refs": { "GetChatControlsConfigurationResponse$blockedPhrases": "The phrases blocked from chat by your chat control configuration.
" } }, "BlockedPhrasesConfigurationUpdate": { "base": "Updates a blocked phrases configuration in your Amazon Q Business application.
", "refs": { "UpdateChatControlsConfigurationRequest$blockedPhrasesConfigurationUpdate": "The phrases blocked from chat by your chat control configuration.
" } }, "Boolean": { "base": null, "refs": { "ActionReviewPayloadField$required": "Information about whether the field is required.
", "CheckDocumentAccessResponse$hasAccess": "A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.
" } }, "BoostingDurationInSeconds": { "base": null, "refs": { "DateAttributeBoostingConfiguration$boostingDurationInSeconds": "Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
The container for browser extension configuration for an Amazon Q Business web experience.
", "refs": { "CreateWebExperienceRequest$browserExtensionConfiguration": "The browser extension configuration for an Amazon Q Business web experience.
For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..
The browser extension configuration for an Amazon Q Business web experience.
", "UpdateWebExperienceRequest$browserExtensionConfiguration": "The browser extension configuration for an Amazon Q Business web experience.
For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..
Specify the browser extensions allowed for your Amazon Q web experience.
CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
FIREFOX — Enables the extension for Mozilla Firefox.
CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
The streaming input for the Chat API.
The streaming input for the Chat API.
The chatMode parameter determines the chat modes available to Amazon Q Business users:
RETRIEVAL_MODE - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a \"No Answer Found\" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge
CREATOR_MODE - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.
PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat to get their responses.
If none of the modes are selected, Amazon Q will only respond using the information from the attached files.
For more information, see Admin controls and guardrails, Plugins, and Response sources.
", "ConfigurationEvent$chatMode": "The chat modes available to an Amazon Q Business end user.
RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.
CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.
PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
" } }, "ChatModeConfiguration": { "base": "Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
", "refs": { "ChatSyncInput$chatModeConfiguration": "The chat mode configuration for an Amazon Q Business application.
", "ConfigurationEvent$chatModeConfiguration": null } }, "ChatOutput": { "base": null, "refs": { } }, "ChatOutputStream": { "base": "The streaming output for the Chat API.
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.
", "refs": { "ChatResponseConfigurations$member": null } }, "ChatResponseConfigurationArn": { "base": null, "refs": { "ChatResponseConfiguration$chatResponseConfigurationArn": "The Amazon Resource Name (ARN) of the chat response configuration, which uniquely identifies the resource across all Amazon Web Services services and accounts.
", "CreateChatResponseConfigurationResponse$chatResponseConfigurationArn": "The Amazon Resource Name (ARN) of the newly created chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
", "GetChatResponseConfigurationResponse$chatResponseConfigurationArn": "The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services.
" } }, "ChatResponseConfigurationDetail": { "base": "Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses.
", "refs": { "GetChatResponseConfigurationResponse$inUseConfiguration": "The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.
", "GetChatResponseConfigurationResponse$lastUpdateConfiguration": "Information about the most recent update to the configuration, including timestamp and modification details.
" } }, "ChatResponseConfigurationId": { "base": null, "refs": { "ChatResponseConfiguration$chatResponseConfigurationId": "A unique identifier for your chat response configuration settings, used to reference and manage the configuration within the Amazon Q Business service.
", "CreateChatResponseConfigurationResponse$chatResponseConfigurationId": "The unique identifier assigned to a newly created chat response configuration, used for subsequent operations on this resource.
", "DeleteChatResponseConfigurationRequest$chatResponseConfigurationId": "The unique identifier of the chat response configuration to delete from the specified application.
", "GetChatResponseConfigurationRequest$chatResponseConfigurationId": "The unique identifier of the chat response configuration to retrieve from the specified application.
", "GetChatResponseConfigurationResponse$chatResponseConfigurationId": "The unique identifier of the retrieved chat response configuration.
", "UpdateChatResponseConfigurationRequest$chatResponseConfigurationId": "The unique identifier of the chat response configuration to update within the specified application.
" } }, "ChatResponseConfigurationStatus": { "base": null, "refs": { "ChatResponseConfiguration$status": "The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use in chat interactions.
", "ChatResponseConfigurationDetail$status": "The current status of the chat response configuration, indicating whether it is active, pending, or in another state that affects its availability for use.
" } }, "ChatResponseConfigurations": { "base": null, "refs": { "ListChatResponseConfigurationsResponse$chatResponseConfigurations": "A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.
" } }, "ChatSyncInput": { "base": null, "refs": { } }, "ChatSyncOutput": { "base": null, "refs": { } }, "CheckDocumentAccessRequest": { "base": null, "refs": { } }, "CheckDocumentAccessResponse": { "base": null, "refs": { } }, "ClientIdForOIDC": { "base": null, "refs": { "ClientIdsForOIDC$member": null } }, "ClientIdsForOIDC": { "base": null, "refs": { "CreateApplicationRequest$clientIdsForOIDC": "The OIDC client ID for a Amazon Q Business application.
", "GetApplicationResponse$clientIdsForOIDC": "The OIDC client ID for a Amazon Q Business application.
" } }, "ClientNamespace": { "base": null, "refs": { "QuickSightConfiguration$clientNamespace": "The Amazon QuickSight namespace that is used as the identity provider. For more information about QuickSight namespaces, see Namespace operations.
" } }, "ClientToken": { "base": null, "refs": { "ChatInput$clientToken": "A token that you provide to identify the chat input.
", "ChatSyncInput$clientToken": "A token that you provide to identify a chat request.
", "CreateApplicationRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business application.
", "CreateDataAccessorRequest$clientToken": "A unique, case-sensitive identifier you provide to ensure idempotency of the request.
", "CreateDataSourceRequest$clientToken": "A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.
A token that you provide to identify the request to create your Amazon Q Business plugin.
", "CreateRetrieverRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business application retriever.
", "CreateSubscriptionRequest$clientToken": "A token that you provide to identify the request to create a subscription for your Amazon Q Business application.
", "CreateUserRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business user mapping.
", "CreateWebExperienceRequest$clientToken": "A token you provide to identify a request to create an Amazon Q Business web experience.
", "UpdateChatControlsConfigurationRequest$clientToken": "A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
" } }, "ConfigurationEvent": { "base": "A configuration event activated by an end user request to select a specific chat mode.
", "refs": { "ChatInputStream$configurationEvent": "A configuration event activated by an end user request to select a specific chat mode.
" } }, "ConflictException": { "base": "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.
", "refs": { } }, "ContentBlockerRule": { "base": "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.
", "refs": { "RuleConfiguration$contentBlockerRule": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
" } }, "ContentRetrievalRule": { "base": "Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
", "refs": { "RuleConfiguration$contentRetrievalRule": null } }, "ContentSource": { "base": "Specifies the source of content to search in.
", "refs": { "SearchRelevantContentRequest$contentSource": "The source of content to search in.
" } }, "ContentType": { "base": null, "refs": { "Document$contentType": "The file type of the document in the Blob field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.
A conversation in an Amazon Q Business application.
", "refs": { "Conversations$member": null } }, "ConversationId": { "base": null, "refs": { "ActionReviewEvent$conversationId": "The identifier of the conversation with which the action review event is associated.
", "Attachment$conversationId": "The identifier of the Amazon Q Business conversation the attachment is associated with.
", "AttachmentOutput$conversationId": "The unique identifier of the Amazon Q Business conversation.
", "ChatInput$conversationId": "The identifier of the Amazon Q Business conversation.
", "ChatSyncInput$conversationId": "The identifier of the Amazon Q Business conversation.
", "ChatSyncOutput$conversationId": "The identifier of the Amazon Q Business conversation.
", "Conversation$conversationId": "The identifier of the Amazon Q Business conversation.
", "ConversationSource$conversationId": "The unique identifier of the Amazon Q Business conversation.
", "DeleteAttachmentRequest$conversationId": "The unique identifier of the conversation.
", "DeleteConversationRequest$conversationId": "The identifier of the Amazon Q Business web experience conversation being deleted.
", "FailedAttachmentEvent$conversationId": "The identifier of the conversation associated with the failed file upload.
", "GetMediaRequest$conversationId": "The identifier of the Amazon Q Business conversation.
", "ListAttachmentsRequest$conversationId": "The unique identifier of the Amazon Q Business web experience conversation.
", "ListMessagesRequest$conversationId": "The identifier of the Amazon Q Business web experience conversation.
", "MetadataEvent$conversationId": "The identifier of the conversation with which the generated metadata is associated.
", "PutFeedbackRequest$conversationId": "The identifier of the conversation the feedback is attached to.
", "TextOutputEvent$conversationId": "The identifier of the conversation with which the text output event is associated.
" } }, "ConversationSource": { "base": "The source reference for an existing attachment in an existing conversation.
", "refs": { "CopyFromSource$conversation": "A reference to an attachment in an existing conversation.
" } }, "ConversationTitle": { "base": null, "refs": { "Conversation$title": "The title of the conversation.
" } }, "Conversations": { "base": null, "refs": { "ListConversationsResponse$conversations": "An array of summary information on the configuration of one or more Amazon Q Business web experiences.
" } }, "CopyFromSource": { "base": "The source reference for an existing attachment.
", "refs": { "Attachment$copyFrom": "A CopyFromSource containing a reference to the original source of the Amazon Q Business attachment.
", "AttachmentInput$copyFrom": "A reference to an existing attachment.
" } }, "CreateAnonymousWebExperienceUrlRequest": { "base": null, "refs": { } }, "CreateAnonymousWebExperienceUrlResponse": { "base": null, "refs": { } }, "CreateApplicationRequest": { "base": null, "refs": { } }, "CreateApplicationResponse": { "base": null, "refs": { } }, "CreateChatResponseConfigurationRequest": { "base": null, "refs": { } }, "CreateChatResponseConfigurationResponse": { "base": null, "refs": { } }, "CreateDataAccessorRequest": { "base": null, "refs": { } }, "CreateDataAccessorResponse": { "base": null, "refs": { } }, "CreateDataSourceRequest": { "base": null, "refs": { } }, "CreateDataSourceResponse": { "base": null, "refs": { } }, "CreateIndexRequest": { "base": null, "refs": { } }, "CreateIndexResponse": { "base": null, "refs": { } }, "CreatePluginRequest": { "base": null, "refs": { } }, "CreatePluginResponse": { "base": null, "refs": { } }, "CreateRetrieverRequest": { "base": null, "refs": { } }, "CreateRetrieverResponse": { "base": null, "refs": { } }, "CreateSubscriptionRequest": { "base": null, "refs": { } }, "CreateSubscriptionResponse": { "base": null, "refs": { } }, "CreateUserRequest": { "base": null, "refs": { } }, "CreateUserRequestUserAliasesList": { "base": null, "refs": { "CreateUserRequest$userAliases": "The list of user aliases in the mapping.
" } }, "CreateUserResponse": { "base": null, "refs": { } }, "CreateWebExperienceRequest": { "base": null, "refs": { } }, "CreateWebExperienceResponse": { "base": null, "refs": { } }, "CreatorModeConfiguration": { "base": "Configuration information required to invoke chat in CREATOR_MODE.
For more information, see Admin controls and guardrails and Conversation settings.
", "refs": { "UpdateChatControlsConfigurationRequest$creatorModeConfiguration": "The configuration details for CREATOR_MODE.
Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
", "CreatorModeConfiguration$creatorModeControl": "Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.
Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
" } }, "CustomPluginConfiguration": { "base": "Configuration information required to create a custom plugin.
", "refs": { "CreatePluginRequest$customPluginConfiguration": "Contains configuration for a custom plugin.
", "GetPluginResponse$customPluginConfiguration": "Configuration information required to create a custom plugin.
", "UpdatePluginRequest$customPluginConfiguration": "The configuration for a custom plugin.
" } }, "CustomizationConfiguration": { "base": "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.
", "refs": { "CreateWebExperienceRequest$customizationConfiguration": "Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
", "GetWebExperienceResponse$customizationConfiguration": "Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.
", "UpdateWebExperienceRequest$customizationConfiguration": "Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.
" } }, "DataAccessor": { "base": "Provides summary information about a data accessor.
", "refs": { "DataAccessors$member": null } }, "DataAccessorArn": { "base": null, "refs": { "CreateDataAccessorResponse$dataAccessorArn": "The Amazon Resource Name (ARN) of the created data accessor.
", "DataAccessor$dataAccessorArn": "The Amazon Resource Name (ARN) of the data accessor.
", "GetDataAccessorResponse$dataAccessorArn": "The Amazon Resource Name (ARN) of the data accessor.
" } }, "DataAccessorAuthenticationConfiguration": { "base": "A union type that contains the specific authentication configuration based on the authentication type selected.
", "refs": { "DataAccessorAuthenticationDetail$authenticationConfiguration": "The specific authentication configuration based on the authentication type.
" } }, "DataAccessorAuthenticationDetail": { "base": "Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
", "refs": { "CreateDataAccessorRequest$authenticationDetail": "The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
", "DataAccessor$authenticationDetail": "The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
", "GetDataAccessorResponse$authenticationDetail": "The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
", "UpdateDataAccessorRequest$authenticationDetail": "The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
" } }, "DataAccessorAuthenticationType": { "base": "The type of authentication mechanism used by the data accessor.
", "refs": { "DataAccessorAuthenticationDetail$authenticationType": "The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
" } }, "DataAccessorId": { "base": null, "refs": { "CreateDataAccessorResponse$dataAccessorId": "The unique identifier of the created data accessor.
", "DataAccessor$dataAccessorId": "The unique identifier of the data accessor.
", "DeleteDataAccessorRequest$dataAccessorId": "The unique identifier of the data accessor to delete.
", "GetDataAccessorRequest$dataAccessorId": "The unique identifier of the data accessor to retrieve.
", "GetDataAccessorResponse$dataAccessorId": "The unique identifier of the data accessor.
", "UpdateDataAccessorRequest$dataAccessorId": "The unique identifier of the data accessor to update.
" } }, "DataAccessorIdcTrustedTokenIssuerConfiguration": { "base": "Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
", "refs": { "DataAccessorAuthenticationConfiguration$idcTrustedTokenIssuerConfiguration": "Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.
A friendly name for the data accessor.
", "DataAccessor$displayName": "The friendly name of the data accessor.
", "GetDataAccessorResponse$displayName": "The friendly name of the data accessor.
", "UpdateDataAccessorRequest$displayName": "The updated friendly name for the data accessor.
" } }, "DataAccessors": { "base": null, "refs": { "ListDataAccessorsResponse$dataAccessors": "The list of data accessors.
" } }, "DataSource": { "base": "A data source in an Amazon Q Business application.
", "refs": { "DataSources$member": null } }, "DataSourceArn": { "base": null, "refs": { "CreateDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
", "GetDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of the data source.
" } }, "DataSourceConfiguration": { "base": "Provides the configuration information for an Amazon Q Business data source.
", "refs": { "CreateDataSourceRequest$configuration": "Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
You can find configuration templates for your specific data source using the following steps:
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
The details of how the data source connector is configured.
", "UpdateDataSourceRequest$configuration": null } }, "DataSourceId": { "base": null, "refs": { "CheckDocumentAccessRequest$dataSourceId": "The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.
", "CreateDataSourceResponse$dataSourceId": "The identifier of the data source connector.
", "DataSource$dataSourceId": "The identifier of the Amazon Q Business data source.
", "DataSourceIds$member": null, "DeleteDataSourceRequest$dataSourceId": "The identifier of the data source connector that you want to delete.
", "DeleteGroupRequest$dataSourceId": "The identifier of the data source linked to the group
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data source.
", "EligibleDataSource$dataSourceId": "The identifier of the data source.
", "FailedDocument$dataSourceId": "The identifier of the Amazon Q Business data source connector that contains the failed document.
", "GetDataSourceRequest$dataSourceId": "The identifier of the data source connector.
", "GetDataSourceResponse$dataSourceId": "The identifier of the data source connector.
", "GetDocumentContentRequest$dataSourceId": "The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be \"uploaded-docs-file-stat-datasourceid\".
", "GetGroupRequest$dataSourceId": "The identifier of the data source the group is attached to.
", "ListDataSourceSyncJobsRequest$dataSourceId": "The identifier of the data source connector.
", "ListGroupsRequest$dataSourceId": "The identifier of the data source for getting a list of groups mapped to users.
", "PutGroupRequest$dataSourceId": "The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only needs access to customer-related documents stored in Salesforce.
", "StartDataSourceSyncJobRequest$dataSourceId": "The identifier of the data source connector.
", "StopDataSourceSyncJobRequest$dataSourceId": "The identifier of the data source connector.
", "UpdateDataSourceRequest$dataSourceId": "The identifier of the data source connector.
", "UserAlias$dataSourceId": "The identifier of the data source that the user aliases are associated with.
" } }, "DataSourceIds": { "base": null, "refs": { "ListDocumentsRequest$dataSourceIds": "The identifier of the data sources the documents are attached to.
" } }, "DataSourceName": { "base": null, "refs": { "CreateDataSourceRequest$displayName": "A name for the data source connector.
", "DataSource$displayName": "The name of the Amazon Q Business data source.
", "GetDataSourceResponse$displayName": "The name for the data source connector.
", "UpdateDataSourceRequest$displayName": "A name of the data source connector.
" } }, "DataSourceStatus": { "base": null, "refs": { "DataSource$status": "The status of the Amazon Q Business data source.
", "GetDataSourceResponse$status": "The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
Provides information about an Amazon Q Business data source connector synchronization job.
", "refs": { "DataSourceSyncJobs$member": null } }, "DataSourceSyncJobMetrics": { "base": "Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
", "refs": { "DataSourceSyncJob$metrics": "Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
" } }, "DataSourceSyncJobStatus": { "base": null, "refs": { "DataSourceSyncJob$status": "The status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
Only returns synchronization jobs with the Status field equal to the specified status.
A history of synchronization jobs for the data source connector.
" } }, "DataSourceUserId": { "base": null, "refs": { "MemberUser$userId": "The identifier of the user you want to map to a group.
" } }, "DataSourceVpcConfiguration": { "base": "Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
", "refs": { "CreateDataSourceRequest$vpcConfiguration": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
", "GetDataSourceResponse$vpcConfiguration": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
", "UpdateDataSourceRequest$vpcConfiguration": null } }, "DataSources": { "base": null, "refs": { "ListDataSourcesResponse$dataSources": "An array of summary information for one or more data source connector.
" } }, "DateAttributeBoostingConfiguration": { "base": "Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "refs": { "DocumentAttributeBoostingConfiguration$dateConfiguration": "Provides information on boosting DATE type document attributes.
Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.
A document deleted from an Amazon Q Business data source connector.
", "refs": { "DeleteDocuments$member": null } }, "DeleteDocuments": { "base": null, "refs": { "BatchDeleteDocumentRequest$documents": "Documents deleted from the Amazon Q Business index.
" } }, "DeleteGroupRequest": { "base": null, "refs": { } }, "DeleteGroupResponse": { "base": null, "refs": { } }, "DeleteIndexRequest": { "base": null, "refs": { } }, "DeleteIndexResponse": { "base": null, "refs": { } }, "DeletePluginRequest": { "base": null, "refs": { } }, "DeletePluginResponse": { "base": null, "refs": { } }, "DeleteRetrieverRequest": { "base": null, "refs": { } }, "DeleteRetrieverResponse": { "base": null, "refs": { } }, "DeleteUserRequest": { "base": null, "refs": { } }, "DeleteUserResponse": { "base": null, "refs": { } }, "DeleteWebExperienceRequest": { "base": null, "refs": { } }, "DeleteWebExperienceResponse": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "CreateApplicationRequest$description": "A description for the Amazon Q Business application.
", "CreateDataSourceRequest$description": "A description for the data source connector.
", "CreateIndexRequest$description": "A description for the Amazon Q Business index.
", "GetApplicationResponse$description": "A description for the Amazon Q Business application.
", "GetDataSourceResponse$description": "The description for the data source connector.
", "GetIndexResponse$description": "The description for the Amazon Q Business index.
", "UpdateApplicationRequest$description": "A description for the Amazon Q Business application.
", "UpdateDataSourceRequest$description": "The description of the data source connector.
", "UpdateIndexRequest$description": "The description of the Amazon Q Business index.
" } }, "DisassociatePermissionRequest": { "base": null, "refs": { } }, "DisassociatePermissionResponse": { "base": null, "refs": { } }, "DisplayName": { "base": null, "refs": { "ChatResponseConfiguration$displayName": "A human-readable name for the chat response configuration, making it easier to identify and manage multiple configurations within an organization.
", "CreateChatResponseConfigurationRequest$displayName": "A human-readable name for the new chat response configuration, making it easier to identify and manage among multiple configurations.
", "GetChatResponseConfigurationResponse$displayName": "The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.
", "UpdateChatResponseConfigurationRequest$displayName": "The new human-readable name to assign to the chat response configuration, making it easier to identify among multiple configurations.
" } }, "Document": { "base": "A document in an Amazon Q Business application.
", "refs": { "Documents$member": null } }, "DocumentAcl": { "base": "Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions.
", "refs": { "CheckDocumentAccessResponse$documentAcl": "The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.
" } }, "DocumentAclCondition": { "base": "Represents a condition in the document's ACL, specifying access rules for users and groups.
", "refs": { "DocumentAclConditions$member": null } }, "DocumentAclConditions": { "base": null, "refs": { "DocumentAclMembership$conditions": "An array of conditions that define the membership rules. Each condition specifies criteria for users or groups to be included in this membership.
" } }, "DocumentAclGroup": { "base": "Represents a group in the document's ACL, used to define access permissions for multiple users collectively.
", "refs": { "DocumentAclGroups$member": null } }, "DocumentAclGroups": { "base": null, "refs": { "DocumentAclCondition$groups": "An array of group identifiers that this condition applies to. Groups listed here are subject to the access rule defined by this condition.
" } }, "DocumentAclMembership": { "base": "Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions.
", "refs": { "DocumentAcl$allowlist": "The allowlist conditions for the document. Users or groups matching these conditions are granted access to the document.
", "DocumentAcl$denyList": "The denylist conditions for the document. Users or groups matching these conditions are denied access to the document, overriding allowlist permissions.
" } }, "DocumentAclUser": { "base": "Represents a user in the document's ACL, used to define access permissions for individual users.
", "refs": { "DocumentAclUsers$member": null } }, "DocumentAclUsers": { "base": null, "refs": { "DocumentAclCondition$users": "An array of user identifiers that this condition applies to. Users listed here are subject to the access rule defined by this condition.
" } }, "DocumentAttribute": { "base": "A document attribute or metadata field.
", "refs": { "AttributeFilter$equalsTo": "Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
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.
In version 2, boosting uses numeric values (ONE, TWO) to indicate priority tiers that establish clear hierarchical relationships between boosted attributes. This allows for more precise control over how different attributes influence search results.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "refs": { "DocumentAttributeBoostingOverrideMap$value": null } }, "DocumentAttributeBoostingLevel": { "base": null, "refs": { "DateAttributeBoostingConfiguration$boostingLevel": "Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
", "NumberAttributeBoostingConfiguration$boostingLevel": "Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
Specifies the priority tier ranking of boosting applied to document attributes. For version 2, this parameter indicates the relative ranking between boosted fields (ONE being highest priority, TWO being second highest, etc.) and determines the order in which attributes influence document ranking in search results. For version 1, this parameter specifies the boosting intensity. For version 2, boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not supported. Note that in version 2, you are not allowed to boost on only one field and make this value TWO.
", "StringListAttributeBoostingConfiguration$boostingLevel": "Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
" } }, "DocumentAttributeCondition": { "base": "The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.
The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
", "InlineDocumentEnrichmentConfiguration$condition": null } }, "DocumentAttributeConfiguration": { "base": "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.
For more information, see Understanding document attributes.
", "refs": { "DocumentAttributeConfigurations$member": null } }, "DocumentAttributeConfigurations": { "base": null, "refs": { "GetIndexResponse$documentAttributeConfigurations": "Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
", "UpdateIndexRequest$documentAttributeConfigurations": "Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
" } }, "DocumentAttributeKey": { "base": null, "refs": { "DocumentAttribute$name": "The identifier for the attribute.
", "DocumentAttributeBoostingOverrideMap$key": null, "DocumentAttributeCondition$key": "The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.
The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
" } }, "DocumentAttributeStringListValue": { "base": null, "refs": { "DocumentAttributeValue$stringListValue": "A list of strings.
" } }, "DocumentAttributeTarget": { "base": "The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition .
The value of a document attribute. You can only provide one value for a document attribute.
", "refs": { "DocumentAttribute$value": "The value of the attribute.
", "DocumentAttributeCondition$value": null, "DocumentAttributeTarget$value": null } }, "DocumentAttributeValueStringValueString": { "base": null, "refs": { "DocumentAttributeValue$stringValue": "A string.
" } }, "DocumentAttributes": { "base": null, "refs": { "Document$attributes": "Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
", "RelevantContent$documentAttributes": "Additional attributes of the document containing the relevant content.
" } }, "DocumentContent": { "base": "The contents of a document.
Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.
The contents of the document.
" } }, "DocumentContentOperator": { "base": null, "refs": { "InlineDocumentEnrichmentConfiguration$documentContentOperator": " TRUE to delete content if the condition used for the target attribute is met.
A list of document details.
" } }, "DocumentDetails": { "base": "The details of a document within an Amazon Q Business index.
", "refs": { "DocumentDetailList$member": null } }, "DocumentEnrichmentConditionOperator": { "base": null, "refs": { "DocumentAttributeCondition$operator": "The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
", "refs": { "CreateDataSourceRequest$documentEnrichmentConfiguration": null, "Document$documentEnrichmentConfiguration": "The configuration information for altering document metadata and content during the document ingestion process.
", "GetDataSourceResponse$documentEnrichmentConfiguration": null, "UpdateDataSourceRequest$documentEnrichmentConfiguration": null } }, "DocumentId": { "base": null, "refs": { "CheckDocumentAccessRequest$documentId": "The unique identifier of the document. Specifies which document's access permissions are being checked.
", "DeleteDocument$documentId": "The identifier of the deleted document.
", "Document$id": "The identifier of the document.
", "DocumentDetails$documentId": "The identifier of the document.
", "FailedDocument$id": "The identifier of the document that couldn't be removed from the Amazon Q Business index.
", "GetDocumentContentRequest$documentId": "The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.
", "RelevantContent$documentId": "The unique identifier of the document containing the relevant content.
" } }, "DocumentMetadataConfigurationName": { "base": null, "refs": { "DocumentAttributeConfiguration$name": "The name of the document attribute.
" } }, "DocumentStatus": { "base": null, "refs": { "DocumentDetails$status": "The current status of the document.
" } }, "Documents": { "base": null, "refs": { "BatchPutDocumentRequest$documents": "One or more documents to add to the index.
Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.
The identifier of the data source Amazon Q Business will generate responses from.
", "refs": { "EligibleDataSources$member": null } }, "EligibleDataSources": { "base": null, "refs": { "ContentRetrievalRule$eligibleDataSources": "Specifies data sources in a Amazon Q Business application to use for content generation.
" } }, "EncryptionConfiguration": { "base": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
", "refs": { "CreateApplicationRequest$encryptionConfiguration": "The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
", "GetApplicationResponse$encryptionConfiguration": "The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
" } }, "EndOfInputEvent": { "base": "The end of the streaming input for the Chat API.
The end of the streaming input for the Chat API.
The code associated with the Amazon Q Business request error.
" } }, "ErrorDetail": { "base": "Provides information about a Amazon Q Business request error.
", "refs": { "Attachment$error": "ErrorDetail providing information about a Amazon Q Business attachment error.
", "AttachmentOutput$error": "An error associated with a file uploaded during chat.
", "ChatResponseConfigurationDetail$error": null, "DataSourceSyncJob$error": "If the Status field is set to FAILED, the ErrorCode field indicates the reason the synchronization failed.
An error message associated with the document.
", "FailedDocument$error": "An explanation for why the document couldn't be removed from the index.
", "GetApplicationResponse$error": "If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
The details of an error associated a group status.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": "The message describing a ConflictException.
The message explaining the Amazon Q Business request error.
", "ExternalResourceException$message": null, "InternalServerException$message": null, "LicenseNotFoundException$message": null, "MediaTooLargeException$message": null, "ResourceNotFoundException$message": "The message describing a ResourceNotFoundException.
The message describing a ServiceQuotaExceededException.
The message describing the ValidationException.
A list of example phrases that you expect the end user to use in relation to the topic.
" } }, "ExecutionId": { "base": null, "refs": { "BatchDeleteDocumentRequest$dataSourceSyncId": "The identifier of the data source sync during which the documents were deleted.
", "BatchPutDocumentRequest$dataSourceSyncId": "The identifier of the data source sync during which the documents were added.
", "DataSourceSyncJob$executionId": "The identifier of a data source synchronization job.
", "StartDataSourceSyncJobResponse$executionId": "The identifier for a particular synchronization job.
" } }, "ExternalResourceException": { "base": "An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again.
", "refs": { } }, "FailedAttachmentEvent": { "base": "A failed file upload during web experience chat.
", "refs": { "ChatOutputStream$failedAttachmentEvent": "A failed file upload event during a web experience chat.
" } }, "FailedDocument": { "base": "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.
", "refs": { "FailedDocuments$member": null } }, "FailedDocuments": { "base": null, "refs": { "BatchDeleteDocumentResponse$failedDocuments": "A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
", "BatchPutDocumentResponse$failedDocuments": "A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
" } }, "FaviconUrl": { "base": null, "refs": { "CustomizationConfiguration$faviconUrl": "Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
" } }, "FontUrl": { "base": null, "refs": { "CustomizationConfiguration$fontUrl": "Provides the URL where the custom font file is hosted for an Amazon Q web experience.
" } }, "GetApplicationRequest": { "base": null, "refs": { } }, "GetApplicationResponse": { "base": null, "refs": { } }, "GetChatControlsConfigurationRequest": { "base": null, "refs": { } }, "GetChatControlsConfigurationResponse": { "base": null, "refs": { } }, "GetChatResponseConfigurationRequest": { "base": null, "refs": { } }, "GetChatResponseConfigurationResponse": { "base": null, "refs": { } }, "GetDataAccessorRequest": { "base": null, "refs": { } }, "GetDataAccessorResponse": { "base": null, "refs": { } }, "GetDataSourceRequest": { "base": null, "refs": { } }, "GetDataSourceResponse": { "base": null, "refs": { } }, "GetDocumentContentRequest": { "base": null, "refs": { } }, "GetDocumentContentResponse": { "base": null, "refs": { } }, "GetGroupRequest": { "base": null, "refs": { } }, "GetGroupResponse": { "base": null, "refs": { } }, "GetIndexRequest": { "base": null, "refs": { } }, "GetIndexResponse": { "base": null, "refs": { } }, "GetMediaRequest": { "base": null, "refs": { } }, "GetMediaResponse": { "base": null, "refs": { } }, "GetPluginRequest": { "base": null, "refs": { } }, "GetPluginResponse": { "base": null, "refs": { } }, "GetPolicyRequest": { "base": null, "refs": { } }, "GetPolicyResponse": { "base": null, "refs": { } }, "GetRetrieverRequest": { "base": null, "refs": { } }, "GetRetrieverResponse": { "base": null, "refs": { } }, "GetUserRequest": { "base": null, "refs": { } }, "GetUserResponse": { "base": null, "refs": { } }, "GetWebExperienceRequest": { "base": null, "refs": { } }, "GetWebExperienceResponse": { "base": null, "refs": { } }, "GroupIdentifier": { "base": null, "refs": { "SubscriptionPrincipal$group": "The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.
" } }, "GroupMembers": { "base": "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.
", "refs": { "PutGroupRequest$groupMembers": null } }, "GroupName": { "base": null, "refs": { "AssociatedGroup$name": "The name of the group associated with the user. This is used to identify the group in access control decisions.
", "DeleteGroupRequest$groupName": "The name of the group you want to delete.
", "DocumentAclGroup$name": "The name of the group in the document's ACL. This is used to identify the group when applying access rules.
", "GetGroupRequest$groupName": "The name of the group.
", "GroupSummary$groupName": "The name of the group the summary information is for.
", "MemberGroup$groupName": "The name of the sub group.
", "PrincipalGroup$name": "The name of the group.
", "PutGroupRequest$groupName": "The list that contains your users or sub groups that belong the same group. For example, the group \"Company\" includes the user \"CEO\" and the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\".
" } }, "GroupStatus": { "base": null, "refs": { "GroupStatusDetail$status": "The status of a group.
" } }, "GroupStatusDetail": { "base": "Provides the details of a group's status.
", "refs": { "GetGroupResponse$status": "The current status of the group.
", "GroupStatusDetails$member": null } }, "GroupStatusDetails": { "base": null, "refs": { "GetGroupResponse$statusHistory": "The status history of the group.
" } }, "GroupSummary": { "base": "Summary information for groups.
", "refs": { "GroupSummaryList$member": null } }, "GroupSummaryList": { "base": null, "refs": { "ListGroupsResponse$items": "Summary information for list of groups that are mapped to users.
" } }, "HallucinationReductionConfiguration": { "base": "Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
The hallucination reduction settings for your application.
", "UpdateChatControlsConfigurationRequest$hallucinationReductionConfiguration": "The hallucination reduction settings for your application.
" } }, "HallucinationReductionControl": { "base": null, "refs": { "HallucinationReductionConfiguration$hallucinationReductionControl": "Controls whether hallucination reduction has been enabled or disabled for your application. The default status is DISABLED.
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the PreExtractionHookConfiguration parameter if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
", "refs": { "DocumentEnrichmentConfiguration$preExtractionHookConfiguration": null, "DocumentEnrichmentConfiguration$postExtractionHookConfiguration": null } }, "IAMIdentityProviderArn": { "base": null, "refs": { "CreateApplicationRequest$iamIdentityProviderArn": "The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
", "GetApplicationResponse$iamIdentityProviderArn": "The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
" } }, "IdcApplicationArn": { "base": null, "refs": { "CreateDataAccessorResponse$idcApplicationArn": "The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.
", "DataAccessor$idcApplicationArn": "The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
", "GetApplicationResponse$identityCenterApplicationArn": "The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
", "GetDataAccessorResponse$idcApplicationArn": "The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.
", "IdcAuthConfiguration$idcApplicationArn": "The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
" } }, "IdcAuthConfiguration": { "base": "Information about the IAM Identity Center Application used to configure authentication for a plugin.
", "refs": { "PluginAuthConfiguration$idcAuthConfiguration": "Information about the IAM Identity Center Application used to configure authentication for a plugin.
" } }, "IdcTrustedTokenIssuerArn": { "base": null, "refs": { "DataAccessorIdcTrustedTokenIssuerConfiguration$idcTrustedTokenIssuerArn": "The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
" } }, "IdentityProviderConfiguration": { "base": "Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
", "refs": { "CreateWebExperienceRequest$identityProviderConfiguration": "Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
", "GetWebExperienceResponse$identityProviderConfiguration": "Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
", "UpdateWebExperienceRequest$identityProviderConfiguration": "Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
" } }, "IdentityType": { "base": null, "refs": { "Application$identityType": "The authentication type being used by a Amazon Q Business application.
", "CreateApplicationRequest$identityType": "The authentication type being used by a Amazon Q Business application.
", "GetApplicationResponse$identityType": "The authentication type being used by a Amazon Q Business application.
" } }, "ImageExtractionConfiguration": { "base": "The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.
", "refs": { "MediaExtractionConfiguration$imageExtractionConfiguration": "The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.
" } }, "ImageExtractionStatus": { "base": null, "refs": { "ImageExtractionConfiguration$imageExtractionStatus": "Specify whether to extract semantic meaning from images and visuals from documents.
" } }, "ImageSourceDetails": { "base": "Details about an image source, including its identifier and format.
", "refs": { "SourceDetails$imageSourceDetails": "Details specific to image content within the source.
" } }, "Index": { "base": "Summary information for your Amazon Q Business index.
", "refs": { "Indices$member": null } }, "IndexArn": { "base": null, "refs": { "CreateIndexResponse$indexArn": "The Amazon Resource Name (ARN) of an Amazon Q Business index.
", "GetIndexResponse$indexArn": "The Amazon Resource Name (ARN) of the Amazon Q Business index.
" } }, "IndexCapacityConfiguration": { "base": "Provides information about index capacity configuration.
", "refs": { "CreateIndexRequest$capacityConfiguration": "The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
", "GetIndexResponse$capacityConfiguration": "The storage capacity units chosen for your Amazon Q Business index.
", "UpdateIndexRequest$capacityConfiguration": "The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
" } }, "IndexCapacityInteger": { "base": null, "refs": { "IndexCapacityConfiguration$units": "The number of storage units configured for an Amazon Q Business index.
" } }, "IndexId": { "base": null, "refs": { "BatchDeleteDocumentRequest$indexId": "The identifier of the Amazon Q Business index that contains the documents to delete.
", "BatchPutDocumentRequest$indexId": "The identifier of the Amazon Q Business index to add the documents to.
", "CheckDocumentAccessRequest$indexId": "The unique identifier of the index. Used to locate the correct index within the application where the document is stored.
", "CreateDataSourceRequest$indexId": "The identifier of the index that you want to use with the data source connector.
", "CreateIndexResponse$indexId": "The identifier for the Amazon Q Business index.
", "DeleteDataSourceRequest$indexId": "The identifier of the index used with the data source connector.
", "DeleteGroupRequest$indexId": "The identifier of the index you want to delete the group from.
", "DeleteIndexRequest$indexId": "The identifier of the Amazon Q Business index.
", "EligibleDataSource$indexId": "The identifier of the index the data source is attached to.
", "GetDataSourceRequest$indexId": "The identfier of the index used with the data source connector.
", "GetDataSourceResponse$indexId": "The identifier of the index linked to the data source connector.
", "GetDocumentContentRequest$indexId": "The identifier of the index where documents are indexed.
", "GetGroupRequest$indexId": "The identifier of the index the group is attached to.
", "GetIndexRequest$indexId": "The identifier of the Amazon Q Business index you want information on.
", "GetIndexResponse$indexId": "The identifier of the Amazon Q Business index.
", "Index$indexId": "The identifier for the index.
", "ListDataSourceSyncJobsRequest$indexId": "The identifier of the index used with the Amazon Q Business data source connector.
", "ListDataSourcesRequest$indexId": "The identifier of the index used with one or more data source connectors.
", "ListDocumentsRequest$indexId": "The identifier of the index the documents are attached to.
", "ListGroupsRequest$indexId": "The identifier of the index for getting a list of groups mapped to users.
", "NativeIndexConfiguration$indexId": "The identifier for the Amazon Q Business index.
", "PutGroupRequest$indexId": "The identifier of the index in which you want to map users to their groups.
", "StartDataSourceSyncJobRequest$indexId": "The identifier of the index used with the data source connector.
", "StopDataSourceSyncJobRequest$indexId": "The identifier of the index used with the Amazon Q Business data source connector.
", "UpdateDataSourceRequest$indexId": "The identifier of the index attached to the data source connector.
", "UpdateIndexRequest$indexId": "The identifier of the Amazon Q Business index.
", "UserAlias$indexId": "The identifier of the index that the user aliases are associated with.
" } }, "IndexName": { "base": null, "refs": { "CreateIndexRequest$displayName": "A name for the Amazon Q Business index.
", "GetIndexResponse$displayName": "The name of the Amazon Q Business index.
", "Index$displayName": "The name of the index.
" } }, "IndexStatistics": { "base": "Provides information about the number of documents in an index.
", "refs": { "GetIndexResponse$indexStatistics": "Provides information about the number of documents indexed.
" } }, "IndexStatus": { "base": null, "refs": { "GetIndexResponse$status": "The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
The current status of the index. When the status is ACTIVE, the index is ready.
The index type that's suitable for your needs. For more information on what's included in each type of index, see Amazon Q Business tiers.
", "GetIndexResponse$type": "The type of index attached to your Amazon Q Business application.
" } }, "IndexedTextBytes": { "base": null, "refs": { "TextDocumentStatistics$indexedTextBytes": "The total size, in bytes, of the indexed documents.
" } }, "IndexedTextDocument": { "base": null, "refs": { "TextDocumentStatistics$indexedTextDocumentCount": "The number of text documents indexed.
" } }, "Indices": { "base": null, "refs": { "ListIndicesResponse$indices": "An array of information on the items in one or more indexes.
" } }, "InlineDocumentEnrichmentConfiguration": { "base": "Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .
For more information, see Custom document enrichment.
", "refs": { "InlineDocumentEnrichmentConfigurations$member": null } }, "InlineDocumentEnrichmentConfigurations": { "base": null, "refs": { "DocumentEnrichmentConfiguration$inlineConfigurations": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
" } }, "InstanceArn": { "base": null, "refs": { "CreateApplicationRequest$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
", "UpdateApplicationRequest$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
" } }, "Instruction": { "base": null, "refs": { "InstructionCollection$responseLength": "Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.
", "InstructionCollection$targetAudience": "Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.
", "InstructionCollection$perspective": "Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.
", "InstructionCollection$outputStyle": "Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.
", "InstructionCollection$identity": "Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.
", "InstructionCollection$tone": "Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.
", "InstructionCollection$customInstructions": "Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.
", "InstructionCollection$examples": "Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.
" } }, "InstructionCollection": { "base": "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.
", "refs": { "ResponseConfiguration$instructionCollection": "A collection of instructions that guide how Amazon Q Business generates responses, including parameters for response length, target audience, perspective, output style, identity, tone, and custom instructions.
" } }, "Integer": { "base": null, "refs": { "ActionReviewPayloadField$displayOrder": "The display order of fields in a payload.
", "Attachment$fileSize": "Size in bytes of the Amazon Q Business attachment.
", "ListChatResponseConfigurationsRequest$maxResults": "The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.
", "SourceAttribution$citationNumber": "The number attached to a citation in an Amazon Q Business generated response.
", "TextSegment$beginOffset": "The zero-based location in the response string where the source attribution starts.
", "TextSegment$endOffset": "The zero-based location in the response string where the source attribution ends.
" } }, "InternalServerException": { "base": "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.
", "refs": { } }, "KendraIndexConfiguration": { "base": "Stores an Amazon Kendra index as a retriever.
", "refs": { "RetrieverConfiguration$kendraIndexConfiguration": "Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
" } }, "KendraIndexId": { "base": null, "refs": { "KendraIndexConfiguration$indexId": "The identifier of the Amazon Kendra index.
" } }, "KmsKeyId": { "base": null, "refs": { "EncryptionConfiguration$kmsKeyId": "The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
" } }, "LambdaArn": { "base": null, "refs": { "HookConfiguration$lambdaArn": "The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
" } }, "LicenseNotFoundException": { "base": "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.
", "refs": { } }, "ListApplicationsRequest": { "base": null, "refs": { } }, "ListApplicationsResponse": { "base": null, "refs": { } }, "ListAttachmentsRequest": { "base": null, "refs": { } }, "ListAttachmentsResponse": { "base": null, "refs": { } }, "ListChatResponseConfigurationsRequest": { "base": null, "refs": { } }, "ListChatResponseConfigurationsResponse": { "base": null, "refs": { } }, "ListConversationsRequest": { "base": null, "refs": { } }, "ListConversationsResponse": { "base": null, "refs": { } }, "ListDataAccessorsRequest": { "base": null, "refs": { } }, "ListDataAccessorsResponse": { "base": null, "refs": { } }, "ListDataSourceSyncJobsRequest": { "base": null, "refs": { } }, "ListDataSourceSyncJobsResponse": { "base": null, "refs": { } }, "ListDataSourcesRequest": { "base": null, "refs": { } }, "ListDataSourcesResponse": { "base": null, "refs": { } }, "ListDocumentsRequest": { "base": null, "refs": { } }, "ListDocumentsResponse": { "base": null, "refs": { } }, "ListGroupsRequest": { "base": null, "refs": { } }, "ListGroupsResponse": { "base": null, "refs": { } }, "ListIndicesRequest": { "base": null, "refs": { } }, "ListIndicesResponse": { "base": null, "refs": { } }, "ListMessagesRequest": { "base": null, "refs": { } }, "ListMessagesResponse": { "base": null, "refs": { } }, "ListPluginActionsRequest": { "base": null, "refs": { } }, "ListPluginActionsResponse": { "base": null, "refs": { } }, "ListPluginTypeActionsRequest": { "base": null, "refs": { } }, "ListPluginTypeActionsResponse": { "base": null, "refs": { } }, "ListPluginTypeMetadataRequest": { "base": null, "refs": { } }, "ListPluginTypeMetadataResponse": { "base": null, "refs": { } }, "ListPluginTypeMetadataSummaries": { "base": null, "refs": { "ListPluginTypeMetadataResponse$items": "An array of information on plugin metadata.
" } }, "ListPluginsRequest": { "base": null, "refs": { } }, "ListPluginsResponse": { "base": null, "refs": { } }, "ListRetrieversRequest": { "base": null, "refs": { } }, "ListRetrieversResponse": { "base": null, "refs": { } }, "ListSubscriptionsRequest": { "base": null, "refs": { } }, "ListSubscriptionsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListWebExperiencesRequest": { "base": null, "refs": { } }, "ListWebExperiencesResponse": { "base": null, "refs": { } }, "LogoUrl": { "base": null, "refs": { "CustomizationConfiguration$logoUrl": "Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
" } }, "Long": { "base": null, "refs": { "AudioSourceDetails$startTimeMilliseconds": "The starting timestamp in milliseconds for the relevant audio segment.
", "AudioSourceDetails$endTimeMilliseconds": "The ending timestamp in milliseconds for the relevant audio segment.
", "DocumentAttributeValue$longValue": "A long integer value.
", "NativeIndexConfiguration$version": "A read-only field that specifies the version of the NativeIndexConfiguration.
Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:
Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting
Version 2 supports a single String field with an ordered list of up to 5 values
Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels
Version 2 allows specifying prioritization between Date and String fields
Version 2 maintains backward compatibility with existing configurations
The starting timestamp in milliseconds for the relevant video segment.
", "VideoSourceDetails$endTimeMilliseconds": "The ending timestamp in milliseconds for the relevant video segment.
" } }, "MaxResults": { "base": null, "refs": { "SearchRelevantContentRequest$maxResults": "The maximum number of results to return.
" } }, "MaxResultsIntegerForGetTopicConfigurations": { "base": null, "refs": { "GetChatControlsConfigurationRequest$maxResults": "The maximum number of configured chat controls to return.
" } }, "MaxResultsIntegerForListApplications": { "base": null, "refs": { "ListApplicationsRequest$maxResults": "The maximum number of Amazon Q Business applications to return.
" } }, "MaxResultsIntegerForListAttachments": { "base": null, "refs": { "ListAttachmentsRequest$maxResults": "The maximum number of attachements to return.
" } }, "MaxResultsIntegerForListConversations": { "base": null, "refs": { "ListConversationsRequest$maxResults": "The maximum number of Amazon Q Business conversations to return.
" } }, "MaxResultsIntegerForListDataAccessors": { "base": null, "refs": { "ListDataAccessorsRequest$maxResults": "The maximum number of results to return in a single call.
" } }, "MaxResultsIntegerForListDataSources": { "base": null, "refs": { "ListDataSourcesRequest$maxResults": "The maximum number of data source connectors to return.
" } }, "MaxResultsIntegerForListDataSourcesSyncJobs": { "base": null, "refs": { "ListDataSourceSyncJobsRequest$maxResults": "The maximum number of synchronization jobs to return in the response.
" } }, "MaxResultsIntegerForListDocuments": { "base": null, "refs": { "ListDocumentsRequest$maxResults": "The maximum number of documents to return.
" } }, "MaxResultsIntegerForListGroupsRequest": { "base": null, "refs": { "ListGroupsRequest$maxResults": "The maximum number of returned groups that are mapped to users.
" } }, "MaxResultsIntegerForListIndices": { "base": null, "refs": { "ListIndicesRequest$maxResults": "The maximum number of indices to return.
" } }, "MaxResultsIntegerForListMessages": { "base": null, "refs": { "ListMessagesRequest$maxResults": "The maximum number of messages to return.
" } }, "MaxResultsIntegerForListPluginActions": { "base": null, "refs": { "ListPluginActionsRequest$maxResults": "The maximum number of plugin actions to return.
" } }, "MaxResultsIntegerForListPluginTypeActions": { "base": null, "refs": { "ListPluginTypeActionsRequest$maxResults": "The maximum number of plugins to return.
" } }, "MaxResultsIntegerForListPluginTypeMetadata": { "base": null, "refs": { "ListPluginTypeMetadataRequest$maxResults": "The maximum number of plugin metadata items to return.
" } }, "MaxResultsIntegerForListPlugins": { "base": null, "refs": { "ListPluginsRequest$maxResults": "The maximum number of documents to return.
" } }, "MaxResultsIntegerForListRetrieversRequest": { "base": null, "refs": { "ListRetrieversRequest$maxResults": "The maximum number of retrievers returned.
" } }, "MaxResultsIntegerForListSubscriptions": { "base": null, "refs": { "ListSubscriptionsRequest$maxResults": "The maximum number of Amazon Q Business subscriptions to return.
" } }, "MaxResultsIntegerForListWebExperiencesRequest": { "base": null, "refs": { "ListWebExperiencesRequest$maxResults": "The maximum number of Amazon Q Business Web Experiences to return.
" } }, "MediaExtractionConfiguration": { "base": "The configuration for extracting information from media in documents.
", "refs": { "CreateDataSourceRequest$mediaExtractionConfiguration": "The configuration for extracting information from media in documents during ingestion.
", "Document$mediaExtractionConfiguration": "The configuration for extracting information from media in the document.
", "GetDataSourceResponse$mediaExtractionConfiguration": "The configuration for extracting information from media in documents for the data source.
", "UpdateDataSourceRequest$mediaExtractionConfiguration": "The configuration for extracting information from media in documents for your data source.
" } }, "MediaId": { "base": null, "refs": { "AudioSourceDetails$mediaId": "Unique identifier for the audio media file.
", "GetMediaRequest$mediaId": "The identifier of the media object. You can find this in the sourceAttributions returned by the Chat, ChatSync, and ListMessages API responses.
Unique identifier for the image file.
", "VideoSourceDetails$mediaId": "Unique identifier for the video media file.
" } }, "MediaTooLargeException": { "base": "The requested media object is too large to be returned.
", "refs": { } }, "MemberGroup": { "base": "The sub groups that belong to a group.
", "refs": { "MemberGroups$member": null } }, "MemberGroups": { "base": null, "refs": { "GroupMembers$memberGroups": "A list of sub groups that belong to a group. For example, the sub groups \"Research\", \"Engineering\", and \"Sales and Marketing\" all belong to the group \"Company\".
" } }, "MemberRelation": { "base": null, "refs": { "AccessConfiguration$memberRelation": "Describes the member relation within the AccessControlList object.
Describes the member relation within a principal list.
", "DocumentAclCondition$memberRelation": "The logical relation between members in the condition, determining how multiple user or group conditions are combined.
", "DocumentAclMembership$memberRelation": "The logical relation between members in the membership rule, determining how multiple conditions are combined.
" } }, "MemberUser": { "base": "The users that belong to a group.
", "refs": { "MemberUsers$member": null } }, "MemberUsers": { "base": null, "refs": { "GroupMembers$memberUsers": "A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.
" } }, "MembershipType": { "base": null, "refs": { "AssociatedGroup$type": "The type of the associated group. This indicates the scope of the group's applicability.
", "AssociatedUser$type": "The type of the associated user. This indicates the scope of the user's association.
", "DocumentAclGroup$type": "The type of the group. This indicates the scope of the group's applicability in access control.
", "DocumentAclUser$type": "The type of the user. This indicates the scope of the user's applicability in access control.
", "MemberGroup$type": "The type of the sub group.
", "MemberUser$type": "The type of the user.
", "PrincipalGroup$membershipType": "The type of group.
", "PrincipalUser$membershipType": "The type of group.
", "PutGroupRequest$type": "The type of the group.
" } }, "Message": { "base": "A message in an Amazon Q Business web experience.
", "refs": { "Messages$member": null } }, "MessageBody": { "base": null, "refs": { "Message$body": "The content of the Amazon Q Business web experience message.
" } }, "MessageId": { "base": null, "refs": { "ActionReviewEvent$userMessageId": "The identifier of the conversation with which the plugin action is associated.
", "ActionReviewEvent$systemMessageId": "The identifier of an Amazon Q Business AI generated associated with the action review event.
", "ChatInput$parentMessageId": "The identifier used to associate a user message with a AI generated response.
", "ChatSyncInput$parentMessageId": "The identifier of the previous system message in a conversation.
", "ChatSyncOutput$systemMessageId": "The identifier of an Amazon Q Business AI generated message within the conversation.
", "ChatSyncOutput$userMessageId": "The identifier of an Amazon Q Business end user text input message within the conversation.
", "FailedAttachmentEvent$userMessageId": "The identifier of the end user chat message associated with the file upload.
", "FailedAttachmentEvent$systemMessageId": "The identifier of the AI-generated message associated with the file upload.
", "GetMediaRequest$messageId": "The identifier of the Amazon Q Business message.
", "MetadataEvent$userMessageId": "The identifier of an Amazon Q Business end user text input message within the conversation.
", "MetadataEvent$systemMessageId": "The identifier of an Amazon Q Business AI generated message within the conversation.
", "TextOutputEvent$userMessageId": "The identifier of an end user message in a TextOutputEvent.
The identifier of an AI-generated message in a TextOutputEvent.
The type of Amazon Q Business message, whether HUMAN or AI generated.
The usefulness value assigned by an end user to a message.
" } }, "MessageUsefulnessComment": { "base": null, "refs": { "MessageUsefulnessFeedback$comment": "A comment given by an end user on the usefulness of an AI-generated chat message.
" } }, "MessageUsefulnessFeedback": { "base": "End user feedback on an AI-generated web experience chat message usefulness.
", "refs": { "PutFeedbackRequest$messageUsefulness": "The feedback usefulness value given by the user to the chat message.
" } }, "MessageUsefulnessReason": { "base": null, "refs": { "MessageUsefulnessFeedback$reason": "The reason for a usefulness rating.
" } }, "Messages": { "base": null, "refs": { "ListMessagesResponse$messages": "An array of information on one or more messages.
" } }, "MetadataEvent": { "base": "A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.
", "refs": { "ChatOutputStream$metadataEvent": "A metadata event for a AI-generated text output message in a Amazon Q Business conversation.
" } }, "MetricValue": { "base": null, "refs": { "DataSourceSyncJobMetrics$documentsAdded": "The current count of documents added from the data source during the data source sync.
", "DataSourceSyncJobMetrics$documentsModified": "The current count of documents modified in the data source during the data source sync.
", "DataSourceSyncJobMetrics$documentsDeleted": "The current count of documents deleted from the data source during the data source sync.
", "DataSourceSyncJobMetrics$documentsFailed": "The current count of documents that failed to sync from the data source during the data source sync.
", "DataSourceSyncJobMetrics$documentsScanned": "The current count of documents crawled by the ongoing sync job in the data source.
" } }, "NativeIndexConfiguration": { "base": "Configuration information for an Amazon Q Business index.
", "refs": { "RetrieverConfiguration$nativeIndexConfiguration": "Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
" } }, "NextToken": { "base": null, "refs": { "GetChatControlsConfigurationRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
", "ListAttachmentsRequest$nextToken": "If the number of attachments returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments.
", "ListChatResponseConfigurationsRequest$nextToken": "A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified maxResults value.
A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the maxResults parameter.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
", "ListDataSourceSyncJobsRequest$nextToken": "If the maxResults response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.
If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
", "ListDataSourcesRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
", "ListDocumentsRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
", "ListGroupsResponse$nextToken": "If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
", "ListIndicesRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
", "ListIndicesResponse$nextToken": "If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
", "ListMessagesRequest$nextToken": "If the number of messages returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
", "ListPluginActionsRequest$nextToken": "If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.
", "ListPluginTypeActionsRequest$nextToken": "If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.
", "ListPluginTypeMetadataRequest$nextToken": "If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.
", "ListPluginsRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
", "ListSubscriptionsRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.
If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.
", "ListWebExperiencesRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
", "SearchRelevantContentRequest$nextToken": "The token for the next set of results. (You received this token from a previous call.)
", "SearchRelevantContentResponse$nextToken": "The token to use to retrieve the next set of results, if there are any.
" } }, "NextToken1500": { "base": null, "refs": { "ListDataAccessorsRequest$nextToken": "The token for the next set of results. (You received this token from a previous call.)
", "ListDataAccessorsResponse$nextToken": "The token to use to retrieve the next set of results, if there are any.
" } }, "NoAuthConfiguration": { "base": "Information about invoking a custom plugin without any authentication or authorization requirement.
", "refs": { "PluginAuthConfiguration$noAuthConfiguration": "Information about invoking a custom plugin without any authentication.
" } }, "NumberAttributeBoostingConfiguration": { "base": "Provides information on boosting NUMBER type document attributes.
In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "refs": { "DocumentAttributeBoostingConfiguration$numberConfiguration": "Provides information on boosting NUMBER type document attributes.
NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
" } }, "OAuth2ClientCredentialConfiguration": { "base": "Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
", "refs": { "PluginAuthConfiguration$oAuth2ClientCredentialConfiguration": "Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
" } }, "OpenIDConnectProviderConfiguration": { "base": "Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
", "refs": { "IdentityProviderConfiguration$openIDConnectConfiguration": null } }, "OrchestrationConfiguration": { "base": "Configuration information required to enable chat orchestration for your Amazon Q Business application.
Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see Supported languages.
The chat response orchestration settings for your application.
" } }, "OrchestrationControl": { "base": null, "refs": { "AppliedOrchestrationConfiguration$control": "Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application.
", "OrchestrationConfiguration$control": "Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.
" } }, "Origin": { "base": null, "refs": { "WebExperienceOrigins$member": null } }, "OutputFormat": { "base": null, "refs": { "GetDocumentContentRequest$outputFormat": "Document outputFormat. Defaults to RAW if not selected.
" } }, "Payload": { "base": null, "refs": { "APISchema$payload": "The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
" } }, "PermissionCondition": { "base": "Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.
", "refs": { "PermissionConditions$member": null } }, "PermissionConditionKey": { "base": null, "refs": { "PermissionCondition$conditionKey": "The key for the condition. This identifies the attribute that the condition applies to.
" } }, "PermissionConditionOperator": { "base": null, "refs": { "PermissionCondition$conditionOperator": "The operator to use for the condition evaluation. This determines how the condition values are compared.
" } }, "PermissionConditionValue": { "base": null, "refs": { "PermissionConditionValues$member": null } }, "PermissionConditionValues": { "base": null, "refs": { "PermissionCondition$conditionValues": "The values to compare against using the specified condition operator.
" } }, "PermissionConditions": { "base": null, "refs": { "AssociatePermissionRequest$conditions": "The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request.
" } }, "PersonalizationConfiguration": { "base": "Configuration information about chat response personalization. For more information, see Personalizing chat responses.
", "refs": { "CreateApplicationRequest$personalizationConfiguration": "Configuration information about chat response personalization. For more information, see Personalizing chat responses
", "GetApplicationResponse$personalizationConfiguration": "Configuration information about chat response personalization. For more information, see Personalizing chat responses.
", "UpdateApplicationRequest$personalizationConfiguration": "Configuration information about chat response personalization. For more information, see Personalizing chat responses.
" } }, "PersonalizationControlMode": { "base": null, "refs": { "PersonalizationConfiguration$personalizationControlMode": "An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
" } }, "Plugin": { "base": "Information about an Amazon Q Business plugin and its configuration.
", "refs": { "Plugins$member": null } }, "PluginArn": { "base": null, "refs": { "CreatePluginResponse$pluginArn": "The Amazon Resource Name (ARN) of a plugin.
", "GetPluginResponse$pluginArn": "The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.
" } }, "PluginAuthConfiguration": { "base": "Authentication configuration information for an Amazon Q Business plugin.
", "refs": { "CreatePluginRequest$authConfiguration": null, "GetPluginResponse$authConfiguration": null, "UpdatePluginRequest$authConfiguration": "The authentication configuration the plugin is using.
" } }, "PluginBuildStatus": { "base": null, "refs": { "CreatePluginResponse$buildStatus": "The current status of a plugin. A plugin is modified asynchronously.
", "GetPluginResponse$buildStatus": "The current status of a plugin. A plugin is modified asynchronously.
", "Plugin$buildStatus": "The status of the plugin.
" } }, "PluginConfiguration": { "base": "Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
", "refs": { "ChatModeConfiguration$pluginConfiguration": "Configuration information required to invoke chat in PLUGIN_MODE.
A description for your custom plugin configuration.
" } }, "PluginId": { "base": null, "refs": { "ActionExecution$pluginId": "The identifier of the plugin the action is attached to.
", "ActionExecutionEvent$pluginId": "The identifier of the plugin for which the action is being requested.
", "ActionReview$pluginId": "The identifier of the plugin associated with the action review.
", "ActionReviewEvent$pluginId": "The identifier of the plugin associated with the action review event.
", "CreatePluginResponse$pluginId": "The identifier of the plugin created.
", "DeletePluginRequest$pluginId": "The identifier of the plugin being deleted.
", "GetPluginRequest$pluginId": "The identifier of the plugin.
", "GetPluginResponse$pluginId": "The identifier of the plugin.
", "ListPluginActionsRequest$pluginId": "The identifier of the Amazon Q Business plugin.
", "Plugin$pluginId": "The identifier of the plugin.
", "PluginConfiguration$pluginId": "The identifier of the plugin you want to use.
", "UpdatePluginRequest$pluginId": "The identifier of the plugin.
" } }, "PluginName": { "base": null, "refs": { "CreatePluginRequest$displayName": "A the name for your plugin.
", "GetPluginResponse$displayName": "The name of the plugin.
", "Plugin$displayName": "The name of the plugin.
", "UpdatePluginRequest$displayName": "The name of the plugin.
" } }, "PluginState": { "base": null, "refs": { "GetPluginResponse$state": "The current state of the plugin.
", "Plugin$state": "The current status of the plugin.
", "UpdatePluginRequest$state": "The status of the plugin.
" } }, "PluginType": { "base": null, "refs": { "ActionReview$pluginType": "The type of plugin.
", "ActionReviewEvent$pluginType": "The type of plugin.
", "CreatePluginRequest$type": "The type of plugin you want to create.
", "GetPluginResponse$type": "The type of the plugin.
", "ListPluginTypeActionsRequest$pluginType": "The type of the plugin.
", "Plugin$type": "The type of the plugin.
", "PluginTypeMetadataSummary$type": "The type of the plugin.
" } }, "PluginTypeCategory": { "base": null, "refs": { "PluginTypeMetadataSummary$category": "The category of the plugin type.
" } }, "PluginTypeMetadataSummary": { "base": "Summary metadata information for a Amazon Q Business plugin.
", "refs": { "ListPluginTypeMetadataSummaries$member": null } }, "Plugins": { "base": null, "refs": { "ListPluginsResponse$plugins": "Information about a configured plugin.
" } }, "Principal": { "base": "Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
", "refs": { "Principals$member": null } }, "PrincipalGroup": { "base": "Provides information about a group associated with the principal.
", "refs": { "Principal$group": "The group associated with the principal.
" } }, "PrincipalRoleArn": { "base": null, "refs": { "AssociatePermissionRequest$principal": "The Amazon Resource Name of the IAM role for the ISV that is being granted permission.
", "CreateDataAccessorRequest$principal": "The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
", "DataAccessor$principal": "The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
", "GetDataAccessorResponse$principal": "The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
" } }, "PrincipalUser": { "base": "Provides information about a user associated with a principal.
", "refs": { "Principal$user": "The user associated with the principal.
" } }, "Principals": { "base": null, "refs": { "AccessControl$principals": "Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.
Configuration information about Amazon Q Apps.
", "refs": { "CreateApplicationRequest$qAppsConfiguration": "An option to allow end users to create and use Amazon Q Apps in the web experience.
", "GetApplicationResponse$qAppsConfiguration": "Settings for whether end users can create and use Amazon Q Apps in the web experience.
", "UpdateApplicationRequest$qAppsConfiguration": "An option to allow end users to create and use Amazon Q Apps in the web experience.
" } }, "QAppsControlMode": { "base": null, "refs": { "QAppsConfiguration$qAppsControlMode": "Status information about whether end users can create and use Amazon Q Apps in the web experience.
" } }, "QIamAction": { "base": null, "refs": { "ActionConfiguration$action": "The Amazon Q Business action that is allowed.
", "QIamActions$member": null } }, "QIamActions": { "base": null, "refs": { "AssociatePermissionRequest$actions": "The list of Amazon Q Business actions that the ISV is allowed to perform.
" } }, "QueryText": { "base": null, "refs": { "SearchRelevantContentRequest$queryText": "The text to search for.
" } }, "QuickSightConfiguration": { "base": "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.
", "refs": { "Application$quickSightConfiguration": "The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider.
", "CreateApplicationRequest$quickSightConfiguration": "The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight for authentication. This configuration is required if your application uses QuickSight as the identity provider. For more information, see Creating an Amazon QuickSight integrated application.
", "GetApplicationResponse$quickSightConfiguration": "The Amazon QuickSight authentication configuration for the Amazon Q Business application.
" } }, "ReadAccessType": { "base": null, "refs": { "PrincipalGroup$access": "Provides information about whether to allow or deny access to the principal.
", "PrincipalUser$access": "Provides information about whether to allow or deny access to the principal.
" } }, "RelevantContent": { "base": "Represents a piece of content that is relevant to a search query.
", "refs": { "RelevantContentList$member": null } }, "RelevantContentList": { "base": null, "refs": { "SearchRelevantContentResponse$relevantContent": "The list of relevant content items found.
" } }, "ResourceNotFoundException": { "base": "The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
", "refs": { } }, "ResponseConfiguration": { "base": "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.
", "refs": { "ResponseConfigurations$value": null } }, "ResponseConfigurationSummary": { "base": null, "refs": { "ChatResponseConfiguration$responseConfigurationSummary": "A summary of the response configuration settings, providing a concise overview of the key parameters that define how responses are generated and formatted.
" } }, "ResponseConfigurationType": { "base": null, "refs": { "ResponseConfigurations$key": null } }, "ResponseConfigurations": { "base": null, "refs": { "ChatResponseConfigurationDetail$responseConfigurations": "A collection of specific response configuration settings that collectively define how responses are generated, formatted, and presented to users in chat interactions.
", "CreateChatResponseConfigurationRequest$responseConfigurations": "A collection of response configuration settings that define how Amazon Q Business will generate and format responses to user queries in chat interactions.
", "UpdateChatResponseConfigurationRequest$responseConfigurations": "The updated collection of response configuration settings that define how Amazon Q Business generates and formats responses to user queries.
" } }, "ResponseScope": { "base": null, "refs": { "GetChatControlsConfigurationResponse$responseScope": "The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
", "UpdateChatControlsConfigurationRequest$responseScope": "The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
" } }, "Retriever": { "base": "Summary information for the retriever used for your Amazon Q Business application.
", "refs": { "Retrievers$member": null } }, "RetrieverArn": { "base": null, "refs": { "CreateRetrieverResponse$retrieverArn": "The Amazon Resource Name (ARN) of an IAM role associated with a retriever.
", "GetRetrieverResponse$retrieverArn": "The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
" } }, "RetrieverConfiguration": { "base": "Provides information on how the retriever used for your Amazon Q Business application is configured.
", "refs": { "CreateRetrieverRequest$configuration": null, "GetRetrieverResponse$configuration": null, "UpdateRetrieverRequest$configuration": null } }, "RetrieverContentSource": { "base": "Specifies a retriever as the content source for a search.
", "refs": { "ContentSource$retriever": "The retriever to use as the content source.
" } }, "RetrieverId": { "base": null, "refs": { "CreateRetrieverResponse$retrieverId": "The identifier of the retriever you are using.
", "DeleteRetrieverRequest$retrieverId": "The identifier of the retriever being deleted.
", "GetRetrieverRequest$retrieverId": "The identifier of the retriever.
", "GetRetrieverResponse$retrieverId": "The identifier of the retriever.
", "Retriever$retrieverId": "The identifier of the retriever used by your Amazon Q Business application.
", "RetrieverContentSource$retrieverId": "The unique identifier of the retriever to use as the content source.
", "UpdateRetrieverRequest$retrieverId": "The identifier of your retriever.
" } }, "RetrieverName": { "base": null, "refs": { "CreateRetrieverRequest$displayName": "The name of your retriever.
", "GetRetrieverResponse$displayName": "The name of the retriever.
", "Retriever$displayName": "The name of your retriever.
", "UpdateRetrieverRequest$displayName": "The name of your retriever.
" } }, "RetrieverStatus": { "base": null, "refs": { "GetRetrieverResponse$status": "The status of the retriever.
", "Retriever$status": "The status of your retriever.
" } }, "RetrieverType": { "base": null, "refs": { "CreateRetrieverRequest$type": "The type of retriever you are using.
", "GetRetrieverResponse$type": "The type of the retriever.
", "Retriever$type": "The type of your retriever.
" } }, "Retrievers": { "base": null, "refs": { "ListRetrieversResponse$retrievers": "An array of summary information for one or more retrievers.
" } }, "RoleArn": { "base": null, "refs": { "BasicAuthConfiguration$roleArn": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
", "BatchPutDocumentRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
", "CreateApplicationRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the application's role.
", "CreateDataSourceRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.
", "CreateRetrieverRequest$roleArn": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
", "CreateWebExperienceRequest$roleArn": "The Amazon Resource Name (ARN) of the service role attached to your web experience.
The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
", "GetDataSourceResponse$roleArn": "The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
", "GetRetrieverResponse$roleArn": "The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
", "GetWebExperienceResponse$roleArn": "The Amazon Resource Name (ARN) of the service role attached to your web experience.
", "HookConfiguration$roleArn": "The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
", "OAuth2ClientCredentialConfiguration$roleArn": "The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
", "OpenIDConnectProviderConfiguration$secretsRole": "An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
", "PutGroupRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.
", "SamlConfiguration$roleArn": "The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
", "UpdateApplicationRequest$roleArn": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
", "UpdateDataSourceRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
", "UpdateRetrieverRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
", "UpdateWebExperienceRequest$roleArn": "The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
" } }, "Rule": { "base": "Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
", "refs": { "Rules$member": null } }, "RuleConfiguration": { "base": "Provides configuration information about a rule.
", "refs": { "Rule$ruleConfiguration": "The configuration information for a rule.
" } }, "RuleType": { "base": null, "refs": { "Rule$ruleType": "The type of rule.
" } }, "Rules": { "base": null, "refs": { "TopicConfiguration$rules": "Rules defined for a topic configuration.
" } }, "S3": { "base": "Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
", "refs": { "APISchema$s3": "Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
", "DocumentContent$s3": "The path to the document in an Amazon S3 bucket.
", "GroupMembers$s3PathForGroupMembers": null } }, "S3BucketName": { "base": null, "refs": { "HookConfiguration$s3BucketName": "Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
", "S3$bucket": "The name of the S3 bucket that contains the file.
" } }, "S3ObjectKey": { "base": null, "refs": { "S3$key": "The name of the file.
" } }, "SamlAttribute": { "base": null, "refs": { "SamlConfiguration$userIdAttribute": "The user attribute name in your IdP that maps to the user email.
", "SamlConfiguration$userGroupAttribute": "The group attribute name in your IdP that maps to user groups.
" } }, "SamlAuthenticationUrl": { "base": null, "refs": { "SamlProviderConfiguration$authenticationUrl": "The URL where Amazon Q Business end users will be redirected for authentication.
" } }, "SamlConfiguration": { "base": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
", "refs": { "WebExperienceAuthConfiguration$samlConfiguration": null } }, "SamlMetadataXML": { "base": null, "refs": { "SamlConfiguration$metadataXML": "The metadata XML that your IdP generated.
" } }, "SamlProviderConfiguration": { "base": "Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
", "refs": { "IdentityProviderConfiguration$samlConfiguration": null } }, "ScoreAttributes": { "base": "Provides information about the relevance score of content.
", "refs": { "RelevantContent$scoreAttributes": "Attributes related to the relevance score of the content.
" } }, "ScoreConfidence": { "base": null, "refs": { "ScoreAttributes$scoreConfidence": "The confidence level of the relevance score.
" } }, "SearchRelevantContentRequest": { "base": null, "refs": { } }, "SearchRelevantContentResponse": { "base": null, "refs": { } }, "SecretArn": { "base": null, "refs": { "BasicAuthConfiguration$secretArn": "The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
", "OAuth2ClientCredentialConfiguration$secretArn": "The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
", "OpenIDConnectProviderConfiguration$secretsArn": "The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIds$member": null } }, "SecurityGroupIds": { "base": null, "refs": { "DataSourceVpcConfiguration$securityGroupIds": "A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
" } }, "ServiceQuotaExceededException": { "base": "You have exceeded the set limits for your Amazon Q Business service.
", "refs": { } }, "SessionDurationInMinutes": { "base": null, "refs": { "CreateAnonymousWebExperienceUrlRequest$sessionDurationInMinutes": "The duration of the session associated with the unique URL for the web experience.
" } }, "SnippetExcerpt": { "base": "Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
", "refs": { "TextSegment$snippetExcerpt": "The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
" } }, "SnippetExcerptText": { "base": null, "refs": { "SnippetExcerpt$text": "The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q chat response.
" } }, "SourceAttribution": { "base": "The documents used to generate an Amazon Q Business web experience response.
", "refs": { "SourceAttributions$member": null } }, "SourceAttributionMediaId": { "base": null, "refs": { "TextSegment$mediaId": "The identifier of the media object associated with the text segment in the source attribution.
" } }, "SourceAttributions": { "base": null, "refs": { "ChatSyncOutput$sourceAttributions": "The source documents used to generate the conversation response.
", "Message$sourceAttribution": "The source documents used to generate Amazon Q Business web experience message.
", "MetadataEvent$sourceAttributions": "The source documents used to generate the conversation response.
" } }, "SourceDetails": { "base": "Container for details about different types of media sources (image, audio, or video).
", "refs": { "TextSegment$sourceDetails": "Source information for a segment of extracted text, including its media type.
" } }, "StartDataSourceSyncJobRequest": { "base": null, "refs": { } }, "StartDataSourceSyncJobResponse": { "base": null, "refs": { } }, "StatementId": { "base": null, "refs": { "AssociatePermissionRequest$statementId": "A unique identifier for the policy statement.
" } }, "Status": { "base": null, "refs": { "DocumentAttributeConfiguration$search": "Information about whether the document attribute can be used by an end user to search for information on their web experience.
" } }, "StopDataSourceSyncJobRequest": { "base": null, "refs": { } }, "StopDataSourceSyncJobResponse": { "base": null, "refs": { } }, "String": { "base": null, "refs": { "ActionReviewPayloadField$displayName": "The name of the field.
", "ActionReviewPayloadField$displayDescription": "The field level description of each action review input field. This could be an explanation of the field. In the Amazon Q Business web experience, these descriptions could be used to display as tool tips to help users understand the field.
", "ActionReviewPayloadField$allowedFormat": "The expected data format for the action review input field value. For example, in PTO request, from and to would be of datetime allowed format.
The identifier of an Amazon Q Business plugin action.
", "ActionSummary$displayName": "The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.
", "ActionSummary$instructionExample": "An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:
Create a Jira task
Create a chat assistant task to find the root cause of a specific incident
The description of an Amazon Q Business plugin action.
", "AssociatePermissionResponse$statement": "The JSON representation of the added permission statement.
", "AssociatedUser$id": "The unique identifier of the associated user. This is used to identify the user in access control decisions.
", "Attachment$fileType": "Filetype of the Amazon Q Business attachment.
", "Attachment$md5chksum": "MD5 checksum of the Amazon Q Business attachment contents.
", "AudioSourceDetails$mediaMimeType": "The MIME type of the audio file (e.g., audio/mp3, audio/wav).
", "ChatResponseConfigurationDetail$responseConfigurationSummary": "A summary of the response configuration details, providing a concise overview of the key parameters and settings that define the response generation behavior.
", "ChatSyncOutput$systemMessage": "An AI-generated message in a conversation.
", "CheckDocumentAccessRequest$userId": "The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.
", "ConflictException$resourceId": "The identifier of the resource affected.
", "ConflictException$resourceType": "The type of the resource affected.
", "CreateChatResponseConfigurationRequest$clientToken": "A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same configuration from being created multiple times if retries occur.
", "CreateUserRequest$userId": "The user emails attached to a user mapping.
", "DataSource$type": "The type of the Amazon Q Business data source.
", "DataSourceSyncJob$dataSourceErrorCode": "If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
", "DeleteUserRequest$userId": "The user email being deleted.
", "DisassociatePermissionRequest$statementId": "The statement ID of the permission to remove.
", "DocumentAclUser$id": "The unique identifier of the user in the document's ACL. This is used to identify the user when applying access rules.
", "DocumentAttributeStringListValue$member": null, "GetDataSourceResponse$type": "The type of the data source connector. For example, S3.
A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.
", "GetDocumentContentResponse$mimeType": "The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document's MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.
", "GetMediaResponse$mediaMimeType": "The MIME type of the media object (image/png).
", "GetPolicyResponse$policy": "The JSON representation of the permission policy.
", "GetUserRequest$userId": "The user email address attached to the user.
", "ImageSourceDetails$mediaMimeType": "The MIME type of the image file.
", "Message$messageId": "The identifier of the Amazon Q Business web experience message.
", "MetadataEvent$finalTextMessage": "The final text output message generated by the system.
", "PluginTypeMetadataSummary$description": "The description assigned by Amazon Q Business to a plugin. You can't modify this value.
", "RelevantContent$content": "The actual content of the relevant item.
", "ResourceNotFoundException$resourceId": "The identifier of the resource affected.
", "ResourceNotFoundException$resourceType": "The type of the resource affected.
", "ServiceQuotaExceededException$resourceId": "The identifier of the resource affected.
", "ServiceQuotaExceededException$resourceType": "The type of the resource affected.
", "SourceAttribution$title": "The title of the document which is the source for the Amazon Q Business generated response.
", "SourceAttribution$snippet": "The content extract from the document on which the generated response is based.
", "SourceAttribution$url": "The URL of the document which is the source for the Amazon Q Business generated response.
", "SourceAttribution$documentId": "The unique identifier of the source document used in the citation, obtained from the Amazon Q Business index during chat response generation. This ID is used as input to the GetDocumentContent API to retrieve the actual document content for user verification.
The identifier of the index containing the source document's metadata and access control information. This links the citation back to the specific Amazon Q Business index where the document's searchable content and permissions are stored.
", "SourceAttribution$datasourceId": "The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API (similar to checkDocumentAccess). If the document is from a file-upload data source, the datasource will be \"uploaded-docs-file-stat-datasourceid\".
", "StringAttributeValueBoosting$key": null, "TextOutputEvent$systemMessage": "An AI-generated message in a TextOutputEvent.
The MIME type (image/png) of the media object associated with the text segment in the source attribution.
", "UpdateChatResponseConfigurationRequest$clientToken": "A unique, case-sensitive identifier to ensure idempotency of the request. This helps prevent the same update from being processed multiple times if retries occur.
", "UpdateUserRequest$userId": "The email id attached to the user.
", "UserAlias$userId": "The identifier of the user id associated with the user aliases.
", "UserGroups$member": null, "UserIds$member": null, "ValidationExceptionField$name": "The field name where the invalid entry was detected.
", "ValidationExceptionField$message": "A message about the validation exception.
", "VideoSourceDetails$mediaMimeType": "The MIME type of the video file (e.g., video/mp4, video/avi).
" } }, "StringAttributeBoostingConfiguration": { "base": "Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "refs": { "DocumentAttributeBoostingConfiguration$stringConfiguration": "Provides information on boosting STRING type document attributes.
Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.
Specifies specific values of a STRING type document attribute being boosted. When using NativeIndexConfiguration version 2, you can specify up to five values in order of priority.
Provides information on boosting STRING_LIST type document attributes.
In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. STRING_LIST attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
For STRING and STRING_LIST type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "refs": { "DocumentAttributeBoostingConfiguration$stringListConfiguration": "Provides information on boosting STRING_LIST type document attributes.
STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.
A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
" } }, "Subscription": { "base": "Information about an Amazon Q Business subscription.
Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.
Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.
The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.
", "CreateSubscriptionResponse$subscriptionArn": "The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.
", "Subscription$subscriptionArn": "The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
", "UpdateSubscriptionResponse$subscriptionArn": "The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.
" } }, "SubscriptionDetails": { "base": "The details of an Amazon Q Business subscription.
", "refs": { "CancelSubscriptionResponse$currentSubscription": "The type of your current Amazon Q Business subscription.
", "CancelSubscriptionResponse$nextSubscription": "The type of the Amazon Q Business subscription for the next month.
", "CreateSubscriptionResponse$currentSubscription": "The type of your current Amazon Q Business subscription.
", "CreateSubscriptionResponse$nextSubscription": "The type of the Amazon Q Business subscription for the next month.
", "Subscription$currentSubscription": "The type of your current Amazon Q Business subscription.
", "Subscription$nextSubscription": "The type of the Amazon Q Business subscription for the next month.
", "UpdateSubscriptionResponse$currentSubscription": "The type of your current Amazon Q Business subscription.
", "UpdateSubscriptionResponse$nextSubscription": "The type of the Amazon Q Business subscription for the next month.
" } }, "SubscriptionId": { "base": null, "refs": { "CancelSubscriptionRequest$subscriptionId": "The identifier of the Amazon Q Business subscription being cancelled.
", "CreateSubscriptionResponse$subscriptionId": "The identifier of the Amazon Q Business subscription created.
", "Subscription$subscriptionId": "The identifier of the Amazon Q Business subscription to be updated.
", "UpdateSubscriptionRequest$subscriptionId": "The identifier of the Amazon Q Business subscription to be updated.
" } }, "SubscriptionPrincipal": { "base": "A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
", "refs": { "CreateSubscriptionRequest$principal": "The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
The IAM Identity Center UserId or GroupId of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.
Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
The type of Amazon Q Business subscription you want to create.
", "SubscriptionDetails$type": "The type of an Amazon Q Business subscription.
", "UpdateSubscriptionRequest$type": "The type of the Amazon Q Business subscription to be updated.
" } }, "Subscriptions": { "base": null, "refs": { "ListSubscriptionsResponse$subscriptions": "An array of summary information on the subscriptions configured for an Amazon Q Business application.
" } }, "SyncSchedule": { "base": null, "refs": { "CreateDataSourceRequest$syncSchedule": "Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The schedule for Amazon Q Business to update the index.
", "UpdateDataSourceRequest$syncSchedule": "The chosen update frequency for your data source.
" } }, "SystemMessageId": { "base": null, "refs": { "PutFeedbackRequest$messageId": "The identifier of the chat message that the feedback was given for.
" } }, "SystemMessageOverride": { "base": null, "refs": { "BlockedPhrasesConfiguration$systemMessageOverride": "The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
", "BlockedPhrasesConfigurationUpdate$systemMessageOverride": "The configured custom message displayed to your end user when they use blocked phrase during chat.
", "ContentBlockerRule$systemMessageOverride": "The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
" } }, "SystemMessageType": { "base": null, "refs": { "TextOutputEvent$systemMessageType": "The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:
RESPONSE - The Amazon Q Business system response.
GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "refs": { "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
", "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The value associated with the tag. The value may be an empty string but it can't be null.
" } }, "Tags": { "base": null, "refs": { "CreateApplicationRequest$tags": "A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateChatResponseConfigurationRequest$tags": "A list of key-value pairs to apply as tags to the new chat response configuration, enabling categorization and management of resources across Amazon Web Services services.
", "CreateDataAccessorRequest$tags": "The tags to associate with the data accessor.
", "CreateDataSourceRequest$tags": "A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateIndexRequest$tags": "A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreatePluginRequest$tags": "A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateRetrieverRequest$tags": "A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateWebExperienceRequest$tags": "A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "ListTagsForResourceResponse$tags": "A list of tags associated with the Amazon Q Business application or data source.
", "TagResourceRequest$tags": "A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.
" } }, "TextDocumentStatistics": { "base": "Provides information about text documents in an index.
", "refs": { "IndexStatistics$textDocumentStatistics": "The number of documents indexed.
" } }, "TextInputEvent": { "base": "An input event for a end user message in an Amazon Q Business web experience.
", "refs": { "ChatInputStream$textEvent": "Information about the payload of the ChatInputStream event containing the end user message input.
An output event for an AI-generated response in an Amazon Q Business web experience.
", "refs": { "ChatOutputStream$textEvent": "Information about the payload of the ChatOutputStream event containing the AI-generated message output.
Provides information about a text extract in a chat response that can be attributed to a source document.
", "refs": { "TextSegmentList$member": null } }, "TextSegmentList": { "base": null, "refs": { "SourceAttribution$textMessageSegments": "A text extract from a source document that is used for source attribution.
" } }, "ThrottlingException": { "base": "The request was denied due to throttling. Reduce the number of requests and try again.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "Application$createdAt": "The Unix timestamp when the Amazon Q Business application was created.
", "Application$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "Attachment$createdAt": "The Unix timestamp when the Amazon Q Business attachment was created.
", "ChatResponseConfiguration$createdAt": "The timestamp indicating when the chat response configuration was initially created, useful for tracking the lifecycle of configuration resources.
", "ChatResponseConfiguration$updatedAt": "The timestamp indicating when the chat response configuration was last modified, helping administrators track changes and maintain version awareness.
", "ChatResponseConfigurationDetail$updatedAt": "The timestamp indicating when the detailed chat response configuration was last modified, helping administrators track changes and maintain version awareness.
", "Conversation$startTime": "The start time of the conversation.
", "DataAccessor$createdAt": "The timestamp when the data accessor was created.
", "DataAccessor$updatedAt": "The timestamp when the data accessor was last updated.
", "DataSource$createdAt": "The Unix timestamp when the Amazon Q Business data source was created.
", "DataSource$updatedAt": "The Unix timestamp when the Amazon Q Business data source was last updated.
", "DataSourceSyncJob$startTime": "The Unix time stamp when the data source synchronization job started.
", "DataSourceSyncJob$endTime": "The Unix timestamp when the synchronization job completed.
", "DocumentAttributeValue$dateValue": "A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
", "DocumentDetails$createdAt": "The timestamp for when the document was created.
", "DocumentDetails$updatedAt": "The timestamp for when the document was last updated.
", "GetApplicationResponse$createdAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "GetApplicationResponse$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "GetChatResponseConfigurationResponse$createdAt": "The timestamp indicating when the chat response configuration was initially created.
", "GetDataAccessorResponse$createdAt": "The timestamp when the data accessor was created.
", "GetDataAccessorResponse$updatedAt": "The timestamp when the data accessor was last updated.
", "GetDataSourceResponse$createdAt": "The Unix timestamp when the data source connector was created.
", "GetDataSourceResponse$updatedAt": "The Unix timestamp when the data source connector was last updated.
", "GetIndexResponse$createdAt": "The Unix timestamp when the Amazon Q Business index was created.
", "GetIndexResponse$updatedAt": "The Unix timestamp when the Amazon Q Business index was last updated.
", "GetPluginResponse$createdAt": "The timestamp for when the plugin was created.
", "GetPluginResponse$updatedAt": "The timestamp for when the plugin was last updated.
", "GetRetrieverResponse$createdAt": "The Unix timestamp when the retriever was created.
", "GetRetrieverResponse$updatedAt": "The Unix timestamp when the retriever was last updated.
", "GetWebExperienceResponse$createdAt": "The Unix timestamp when the Amazon Q Business web experience was last created.
", "GetWebExperienceResponse$updatedAt": "The Unix timestamp when the Amazon Q Business web experience was last updated.
", "GroupStatusDetail$lastUpdatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "Index$createdAt": "The Unix timestamp when the index was created.
", "Index$updatedAt": "The Unix timestamp when the index was last updated.
", "ListDataSourceSyncJobsRequest$startTime": "The start time of the data source connector sync.
", "ListDataSourceSyncJobsRequest$endTime": "The end time of the data source connector sync.
", "ListGroupsRequest$updatedEarlierThan": "The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
The timestamp of the first Amazon Q Business web experience message.
", "MessageUsefulnessFeedback$submittedAt": "The timestamp for when the feedback was submitted.
", "Plugin$createdAt": "The timestamp for when the plugin was created.
", "Plugin$updatedAt": "The timestamp for when the plugin was last updated.
", "PutFeedbackRequest$messageCopiedAt": "The timestamp for when the feedback was recorded.
", "SourceAttribution$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "WebExperience$createdAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "WebExperience$updatedAt": "The Unix timestamp when your Amazon Q Business web experience was updated.
" } }, "Title": { "base": null, "refs": { "Document$title": "The title of the document.
", "RelevantContent$documentTitle": "The title of the document containing the relevant content.
" } }, "TopicConfiguration": { "base": "The topic specific controls configured for an Amazon Q Business application.
", "refs": { "TopicConfigurations$member": null } }, "TopicConfigurationName": { "base": null, "refs": { "TopicConfiguration$name": "A name for your topic control configuration.
" } }, "TopicConfigurations": { "base": null, "refs": { "GetChatControlsConfigurationResponse$topicConfigurations": "The topic specific controls configured for a Amazon Q Business application.
", "UpdateChatControlsConfigurationRequest$topicConfigurationsToCreateOrUpdate": "The configured topic specific chat controls you want to update.
", "UpdateChatControlsConfigurationRequest$topicConfigurationsToDelete": "The configured topic specific chat controls you want to delete.
" } }, "TopicDescription": { "base": null, "refs": { "TopicConfiguration$description": "A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateApplicationRequest": { "base": null, "refs": { } }, "UpdateApplicationResponse": { "base": null, "refs": { } }, "UpdateChatControlsConfigurationRequest": { "base": null, "refs": { } }, "UpdateChatControlsConfigurationResponse": { "base": null, "refs": { } }, "UpdateChatResponseConfigurationRequest": { "base": null, "refs": { } }, "UpdateChatResponseConfigurationResponse": { "base": null, "refs": { } }, "UpdateDataAccessorRequest": { "base": null, "refs": { } }, "UpdateDataAccessorResponse": { "base": null, "refs": { } }, "UpdateDataSourceRequest": { "base": null, "refs": { } }, "UpdateDataSourceResponse": { "base": null, "refs": { } }, "UpdateIndexRequest": { "base": null, "refs": { } }, "UpdateIndexResponse": { "base": null, "refs": { } }, "UpdatePluginRequest": { "base": null, "refs": { } }, "UpdatePluginResponse": { "base": null, "refs": { } }, "UpdateRetrieverRequest": { "base": null, "refs": { } }, "UpdateRetrieverResponse": { "base": null, "refs": { } }, "UpdateSubscriptionRequest": { "base": null, "refs": { } }, "UpdateSubscriptionResponse": { "base": null, "refs": { } }, "UpdateUserRequest": { "base": null, "refs": { } }, "UpdateUserResponse": { "base": null, "refs": { } }, "UpdateWebExperienceRequest": { "base": null, "refs": { } }, "UpdateWebExperienceResponse": { "base": null, "refs": { } }, "Url": { "base": null, "refs": { "AuthChallengeRequest$authorizationUrl": "The URL sent by Amazon Q Business to the third party authentication server to authenticate a custom plugin user through an OAuth protocol.
", "AuthChallengeRequestEvent$authorizationUrl": "The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.
", "CreateAnonymousWebExperienceUrlResponse$anonymousUrl": "The unique URL for accessing the web experience.
This URL can only be used once and must be used within 5 minutes after it's generated.
The source URL used for plugin configuration.
", "GetPluginResponse$serverUrl": "The source URL used for plugin configuration.
", "GetWebExperienceResponse$defaultEndpoint": "The endpoint of your Amazon Q Business web experience.
", "OAuth2ClientCredentialConfiguration$authorizationUrl": "The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
", "OAuth2ClientCredentialConfiguration$tokenUrl": "The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
", "Plugin$serverUrl": "The plugin server URL used for configuration.
", "RelevantContent$documentUri": "The URI of the document containing the relevant content.
", "UpdatePluginRequest$serverUrl": "The source URL used for plugin configuration.
", "WebExperience$defaultEndpoint": "The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
" } }, "UserAlias": { "base": "Aliases attached to a user id within an Amazon Q Business application.
", "refs": { "CreateUserRequestUserAliasesList$member": null, "UserAliases$member": null } }, "UserAliases": { "base": null, "refs": { "GetUserResponse$userAliases": "A list of user aliases attached to a user.
", "UpdateUserRequest$userAliasesToUpdate": "The user aliases attached to the user id that are to be updated.
", "UpdateUserRequest$userAliasesToDelete": "The user aliases attached to the user id that are to be deleted.
", "UpdateUserResponse$userAliasesAdded": "The user aliases that have been to be added to a user id.
", "UpdateUserResponse$userAliasesUpdated": "The user aliases attached to a user id that have been updated.
", "UpdateUserResponse$userAliasesDeleted": "The user aliases that have been deleted from a user id.
" } }, "UserGroups": { "base": null, "refs": { "ChatInput$userGroups": "The group names that a user associated with the chat input belongs to.
", "ChatSyncInput$userGroups": "The group names that a user associated with the chat input belongs to.
", "UsersAndGroups$userGroups": "The user group names associated with a topic control rule.
" } }, "UserId": { "base": null, "refs": { "ChatInput$userId": "The identifier of the user attached to the chat input.
", "ChatSyncInput$userId": "The identifier of the user attached to the chat input.
", "DeleteAttachmentRequest$userId": "The unique identifier of the user involved in the conversation.
", "DeleteConversationRequest$userId": "The identifier of the user who is deleting the conversation.
", "ListAttachmentsRequest$userId": "The unique identifier of the user involved in the Amazon Q Business web experience conversation.
", "ListConversationsRequest$userId": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", "ListMessagesRequest$userId": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", "PrincipalUser$id": "The identifier of the user.
", "PutFeedbackRequest$userId": "The identifier of the user giving the feedback.
" } }, "UserIdentifier": { "base": null, "refs": { "SubscriptionPrincipal$user": "The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.
" } }, "UserIds": { "base": null, "refs": { "UsersAndGroups$userIds": "The user ids associated with a topic control rule.
" } }, "UserMessage": { "base": null, "refs": { "ChatSyncInput$userMessage": "A end user message in a conversation.
", "TextInputEvent$userMessage": "A user message in a text message input event.
" } }, "UsersAndGroups": { "base": "Provides information about users and group names associated with a topic control rule.
", "refs": { "Rule$includedUsersAndGroups": "Users and groups to be included in a rule.
", "Rule$excludedUsersAndGroups": "Users and groups to be excluded from a rule.
" } }, "ValidationException": { "base": "The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
", "refs": { } }, "ValidationExceptionField": { "base": "The input failed to meet the constraints specified by Amazon Q Business in a specified field.
", "refs": { "ValidationExceptionFields$member": null } }, "ValidationExceptionFields": { "base": null, "refs": { "ValidationException$fields": "The input field(s) that failed validation.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason for the ValidationException.
Configuration settings for video content extraction and processing.
", "refs": { "MediaExtractionConfiguration$videoExtractionConfiguration": "Configuration settings for extracting and processing video content from media files.
" } }, "VideoExtractionStatus": { "base": null, "refs": { "VideoExtractionConfiguration$videoExtractionStatus": "The status of video extraction (ENABLED or DISABLED) for processing video content from files.
" } }, "VideoExtractionType": { "base": null, "refs": { "VideoSourceDetails$videoExtractionType": "The type of video extraction performed on the content.
" } }, "VideoSourceDetails": { "base": "Details about a video source, including its identifier, format, and time information.
", "refs": { "SourceDetails$videoSourceDetails": "Details specific to video content within the source.
" } }, "WebExperience": { "base": "Provides information for an Amazon Q Business web experience.
", "refs": { "WebExperiences$member": null } }, "WebExperienceArn": { "base": null, "refs": { "CreateWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
", "GetWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
" } }, "WebExperienceAuthConfiguration": { "base": "Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
", "refs": { "GetWebExperienceResponse$authenticationConfiguration": "The authentication configuration information for your Amazon Q Business web experience.
", "UpdateWebExperienceRequest$authenticationConfiguration": "The authentication configuration of the Amazon Q Business web experience.
" } }, "WebExperienceId": { "base": null, "refs": { "CreateAnonymousWebExperienceUrlRequest$webExperienceId": "The identifier of the web experience.
", "CreateWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q Business web experience.
", "DeleteWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience being deleted.
", "GetWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience.
", "GetWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q Business web experience.
", "UpdateWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience.
", "WebExperience$webExperienceId": "The identifier of your Amazon Q Business web experience.
" } }, "WebExperienceOrigins": { "base": null, "refs": { "CreateWebExperienceRequest$origins": "Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).
Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).
Any values except null submitted as part of this update will replace all previous values.
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
Determines whether sample prompts are enabled in the web experience for an end user.
", "GetWebExperienceResponse$samplePromptsControlMode": "Determines whether sample prompts are enabled in the web experience for an end user.
", "UpdateWebExperienceRequest$samplePromptsControlMode": "Determines whether sample prompts are enabled in the web experience for an end user.
" } }, "WebExperienceStatus": { "base": null, "refs": { "GetWebExperienceResponse$status": "The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
The status of your Amazon Q Business web experience.
" } }, "WebExperienceSubtitle": { "base": null, "refs": { "CreateWebExperienceRequest$subtitle": "A subtitle to personalize your Amazon Q Business web experience.
", "GetWebExperienceResponse$subtitle": "The subtitle for your Amazon Q Business web experience.
", "UpdateWebExperienceRequest$subtitle": "The subtitle of the Amazon Q Business web experience.
" } }, "WebExperienceTitle": { "base": null, "refs": { "CreateWebExperienceRequest$title": "The title for your Amazon Q Business web experience.
", "GetWebExperienceResponse$title": "The title for your Amazon Q Business web experience.
", "UpdateWebExperienceRequest$title": "The title of the Amazon Q Business web experience.
" } }, "WebExperienceWelcomeMessage": { "base": null, "refs": { "CreateWebExperienceRequest$welcomeMessage": "The customized welcome message for end users of an Amazon Q Business web experience.
", "GetWebExperienceResponse$welcomeMessage": "The customized welcome message for end users of an Amazon Q Business web experience.
", "UpdateWebExperienceRequest$welcomeMessage": "A customized welcome message for an end user in an Amazon Q Business web experience.
" } }, "WebExperiences": { "base": null, "refs": { "ListWebExperiencesResponse$webExperiences": "An array of summary information for one or more Amazon Q Business experiences.
" } } } }