", "operations": { "BatchDeleteDocument": "
Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q 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 index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.
add custom attributes to documents in an Amazon Q index.
attach an access control list to the documents added to an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
", "ChatSync": "Starts or continues a non-streaming Amazon Q conversation.
", "CreateApplication": "Creates an Amazon Q application.
", "CreateDataSource": "Creates a data source connector for an Amazon Q 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 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 plugin.
", "CreateRetriever": "Adds a retriever to your Amazon Q application.
", "CreateUser": "Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
", "CreateWebExperience": "Creates an Amazon Q web experience.
", "DeleteApplication": "Deletes an Amazon Q application.
", "DeleteChatControlsConfiguration": "Deletes chat controls configured for an existing Amazon Q application.
", "DeleteConversation": "Deletes an Amazon Q web experience conversation.
", "DeleteDataSource": "Deletes an Amazon Q 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 index.
", "DeletePlugin": "Deletes an Amazon Q plugin.
", "DeleteRetriever": "Deletes the retriever used by an Amazon Q application.
", "DeleteUser": "Deletes a user by email id.
", "DeleteWebExperience": "Deletes an Amazon Q web experience.
", "GetApplication": "Gets information about an existing Amazon Q application.
", "GetChatControlsConfiguration": "Gets information about an chat controls configured for an existing Amazon Q application.
", "GetDataSource": "Gets information about an existing Amazon Q data source connector.
", "GetGroup": "Describes a group by group name.
", "GetIndex": "Gets information about an existing Amazon Q index.
", "GetPlugin": "Gets information about an existing Amazon Q plugin.
", "GetRetriever": "Gets information about an existing retriever used by an Amazon Q 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 web experience.
", "ListApplications": "Lists Amazon Q applications.
", "ListConversations": "Lists one or more Amazon Q conversations.
", "ListDataSourceSyncJobs": "Get information about an Amazon Q data source connector synchronization.
", "ListDataSources": "Lists the Amazon Q 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 indices you have created.
", "ListMessages": "Gets a list of messages associated with an Amazon Q web experience.
", "ListPlugins": "Lists configured Amazon Q plugins.
", "ListRetrievers": "Lists the retriever used by an Amazon Q application.
", "ListTagsForResource": "Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
", "ListWebExperiences": "Lists one or more Amazon Q Web Experiences.
", "PutFeedback": "Enables your end user to to provide feedback on their Amazon Q 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 chat results.
", "StartDataSourceSyncJob": "Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.
Stops an Amazon Q data source connector synchronization job already in progress.
", "TagResource": "Adds the specified tag to the specified Amazon Q 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 application or a data source.
", "UpdateApplication": "Updates an existing Amazon Q application.
", "UpdateChatControlsConfiguration": "Updates an set of chat controls configured for an existing Amazon Q application.
", "UpdateDataSource": "Updates an existing Amazon Q data source connector.
", "UpdateIndex": "Updates an Amazon Q index.
", "UpdatePlugin": "Updates an Amazon Q plugin.
", "UpdateRetriever": "Updates the retriever used for your Amazon Q application.
", "UpdateUser": "Updates a information associated with a user id.
", "UpdateWebExperience": "Updates an Amazon Q web experience.
" }, "shapes": { "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": { } }, "ActionExecution": { "base": "Performs an Amazon Q plugin action during a non-streaming chat conversation.
", "refs": { "ChatSyncInput$actionExecution": "A request from an end user to perform an Amazon Q plugin action.
", "Message$actionExecution": null } }, "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 requests to perform their plugin action.
" } }, "ActionExecutionPayloadField": { "base": "A user input field in an plugin action execution payload.
", "refs": { "ActionExecutionPayload$value": null } }, "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.
", "ActionReview$payloadFieldNameSeparator": "A string used to retain information about the hierarchical contexts within an action review 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$displayValue": "The name of the field.
", "ActionReviewPayloadFieldAllowedValue$value": "The field value.
" } }, "ActionReview": { "base": "An output event that Amazon Q returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q.
", "refs": { "ChatSyncOutput$actionReview": "A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.
", "Message$actionReview": null } }, "ActionReviewPayload": { "base": null, "refs": { "ActionReview$payload": "Field values that an end user needs to provide to Amazon Q for Amazon Q 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 for Amazon Q 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 for Amazon Q to perform the requested plugin action.
" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.
", "TagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.
", "UntagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.
" } }, "Application": { "base": "Summary information for an Amazon Q application.
", "refs": { "Applications$member": null } }, "ApplicationArn": { "base": null, "refs": { "CreateApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q application.
", "GetApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q application.
" } }, "ApplicationId": { "base": null, "refs": { "Application$applicationId": "The identifier for the Amazon Q application.
", "BatchDeleteDocumentRequest$applicationId": "The identifier of the Amazon Q application.
", "BatchPutDocumentRequest$applicationId": "The identifier of the Amazon Q application.
", "ChatSyncInput$applicationId": "The identifier of the Amazon Q application linked to the Amazon Q conversation.
", "CreateApplicationResponse$applicationId": "The identifier of the Amazon Q application.
", "CreateDataSourceRequest$applicationId": "The identifier of the Amazon Q application the data source will be attached to.
", "CreateIndexRequest$applicationId": "The identifier of the Amazon Q application using the index.
", "CreatePluginRequest$applicationId": "The identifier of the application that will contain the plugin.
", "CreateRetrieverRequest$applicationId": "The identifier of your Amazon Q application.
", "CreateUserRequest$applicationId": "The identifier of the application for which the user mapping will be created.
", "CreateWebExperienceRequest$applicationId": "The identifier of the Amazon Q web experience.
", "DeleteApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", "DeleteChatControlsConfigurationRequest$applicationId": "The identifier of the application the chat controls have been configured for.
", "DeleteConversationRequest$applicationId": "The identifier of the Amazon Q application associated with the conversation.
", "DeleteDataSourceRequest$applicationId": "The identifier of the Amazon Q 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 application the Amazon Q index is linked to.
", "DeletePluginRequest$applicationId": "The identifier the application attached to the Amazon Q plugin.
", "DeleteRetrieverRequest$applicationId": "The identifier of the Amazon Q 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 application linked to the Amazon Q web experience.
", "GetApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", "GetApplicationResponse$applicationId": "The identifier of the Amazon Q application.
", "GetChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", "GetDataSourceRequest$applicationId": "The identifier of the Amazon Q application.
", "GetDataSourceResponse$applicationId": "The identifier of the Amazon Q application.
", "GetGroupRequest$applicationId": "The identifier of the application id the group is attached to.
", "GetIndexRequest$applicationId": "The identifier of the Amazon Q application connected to the index.
", "GetIndexResponse$applicationId": "The identifier of the Amazon Q application associated with the index.
", "GetPluginRequest$applicationId": "The identifier of the application which contains the plugin.
", "GetPluginResponse$applicationId": "The identifier of the application which contains the plugin.
", "GetRetrieverRequest$applicationId": "The identifier of the Amazon Q application using the retriever.
", "GetRetrieverResponse$applicationId": "The identifier of the Amazon Q application using the retriever.
", "GetUserRequest$applicationId": "The identifier of the application connected to the user.
", "GetWebExperienceRequest$applicationId": "The identifier of the Amazon Q application linked to the web experience.
", "GetWebExperienceResponse$applicationId": "The identifier of the Amazon Q application linked to the web experience.
", "ListConversationsRequest$applicationId": "The identifier of the Amazon Q application.
", "ListDataSourceSyncJobsRequest$applicationId": "The identifier of the Amazon Q application connected to the data source.
", "ListDataSourcesRequest$applicationId": "The identifier of the Amazon Q 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 application connected to the index.
", "ListMessagesRequest$applicationId": "The identifier for the Amazon Q application.
", "ListPluginsRequest$applicationId": "The identifier of the application the plugin is attached to.
", "ListRetrieversRequest$applicationId": "The identifier of the Amazon Q application using the retriever.
", "ListWebExperiencesRequest$applicationId": "The identifier of the Amazon Q 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 application using the retriever.
", "StartDataSourceSyncJobRequest$applicationId": "The identifier of Amazon Q application the data source is connected to.
", "StopDataSourceSyncJobRequest$applicationId": "The identifier of the Amazon Q application that the data source is connected to.
", "UpdateApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", "UpdateChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", "UpdateDataSourceRequest$applicationId": "The identifier of the Amazon Q application the data source is attached to.
", "UpdateIndexRequest$applicationId": "The identifier of the Amazon Q 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 application.
", "UpdateUserRequest$applicationId": "The identifier of the application the user is attached to.
", "UpdateWebExperienceRequest$applicationId": "The identifier of the Amazon Q application attached to the web experience.
" } }, "ApplicationName": { "base": null, "refs": { "Application$displayName": "The name of the Amazon Q application.
", "CreateApplicationRequest$displayName": "A name for the Amazon Q application.
", "GetApplicationResponse$displayName": "The name of the Amazon Q application.
", "UpdateApplicationRequest$displayName": "A name for the Amazon Q application.
", "UpdateIndexRequest$displayName": "The name of the Amazon Q index.
" } }, "ApplicationStatus": { "base": null, "refs": { "Application$status": "The status of the Amazon Q application. The application is ready to use when the status is ACTIVE.
The status of the Amazon Q application.
" } }, "Applications": { "base": null, "refs": { "ListApplicationsResponse$applications": "An array of summary information on the configuration of one or more Amazon Q 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.
" } }, "AttachmentInput": { "base": "A file directly uploaded into a web experience chat.
", "refs": { "AttachmentsInput$member": null } }, "AttachmentName": { "base": null, "refs": { "AttachmentInput$name": "The name of the file.
", "AttachmentOutput$name": "The name of a file uploaded during chat.
" } }, "AttachmentOutput": { "base": "The details of a file uploaded during chat.
", "refs": { "AttachmentsOutput$member": null } }, "AttachmentStatus": { "base": null, "refs": { "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 web experience chat.
" } }, "AttributeFilter": { "base": "Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
", "refs": { "AttributeFilter$notFilter": "Performs a logical NOT operation on all supplied filters.
Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
" } }, "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.
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 data contained within the uploaded file.
", "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 APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.
A list of phrases blocked from a Amazon Q web experience chat.
", "BlockedPhrasesConfigurationUpdate$blockedPhrasesToCreateOrUpdate": "Creates or updates a blocked phrases configuration in your Amazon Q application.
", "BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete": "Deletes a blocked phrases configuration in your Amazon Q 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 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.
" } }, "ChatSyncInput": { "base": null, "refs": { } }, "ChatSyncOutput": { "base": null, "refs": { } }, "ClientToken": { "base": null, "refs": { "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 application.
", "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 plugin.
", "CreateRetrieverRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q application retriever.
", "CreateUserRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q user mapping.
", "CreateWebExperienceRequest$clientToken": "A token you provide to identify a request to create an Amazon Q web experience.
", "UpdateChatControlsConfigurationRequest$clientToken": "A token that you provide to identify the request to update a Amazon Q application chat configuration.
" } }, "ConflictException": { "base": "You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
", "refs": { } }, "ContentBlockerRule": { "base": "A rule for configuring how Amazon Q responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
", "refs": { "RuleConfiguration$contentBlockerRule": "A rule for configuring how Amazon Q responds when it encounters a a blocked topic.
" } }, "ContentRetrievalRule": { "base": "Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.
", "refs": { "RuleConfiguration$contentRetrievalRule": null } }, "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 application.
", "refs": { "Conversations$member": null } }, "ConversationId": { "base": null, "refs": { "ChatSyncInput$conversationId": "The identifier of the Amazon Q conversation.
", "ChatSyncOutput$conversationId": "The identifier of the Amazon Q conversation.
", "Conversation$conversationId": "The identifier of the Amazon Q conversation.
", "DeleteConversationRequest$conversationId": "The identifier of the Amazon Q web experience conversation being deleted.
", "ListMessagesRequest$conversationId": "The identifier of the Amazon Q web experience conversation.
", "PutFeedbackRequest$conversationId": "The identifier of the conversation the feedback is attached to.
" } }, "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 web experiences.
" } }, "CreateApplicationRequest": { "base": null, "refs": { } }, "CreateApplicationResponse": { "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": { } }, "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": { } }, "DataSource": { "base": "A data source in an Amazon Q application.
", "refs": { "DataSources$member": null } }, "DataSourceArn": { "base": null, "refs": { "CreateDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of a data source in an Amazon Q application.
", "GetDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of the data source.
" } }, "DataSourceConfiguration": { "base": "Provides the configuration information for an Amazon Q data source.
", "refs": { "CreateDataSourceRequest$configuration": "Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
", "GetDataSourceResponse$configuration": "The details of how the data source connector is configured.
", "UpdateDataSourceRequest$configuration": null } }, "DataSourceId": { "base": null, "refs": { "CreateDataSourceResponse$dataSourceId": "The identifier of the data source connector.
", "DataSource$dataSourceId": "The identifier of the Amazon Q 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 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.
", "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 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 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 data source connector synchronization job.
", "refs": { "DataSourceSyncJobs$member": null } }, "DataSourceSyncJobMetrics": { "base": "Maps a batch delete document request to a specific Amazon Q 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 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.
" } }, "DeleteApplicationRequest": { "base": null, "refs": { } }, "DeleteApplicationResponse": { "base": null, "refs": { } }, "DeleteChatControlsConfigurationRequest": { "base": null, "refs": { } }, "DeleteChatControlsConfigurationResponse": { "base": null, "refs": { } }, "DeleteConversationRequest": { "base": null, "refs": { } }, "DeleteConversationResponse": { "base": null, "refs": { } }, "DeleteDataSourceRequest": { "base": null, "refs": { } }, "DeleteDataSourceResponse": { "base": null, "refs": { } }, "DeleteDocument": { "base": "A document deleted from an Amazon Q data source connector.
", "refs": { "DeleteDocuments$member": null } }, "DeleteDocuments": { "base": null, "refs": { "BatchDeleteDocumentRequest$documents": "Documents deleted from the Amazon Q 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 application.
", "CreateDataSourceRequest$description": "A description for the data source connector.
", "CreateIndexRequest$description": "A description for the Amazon Q index.
", "GetApplicationResponse$description": "A description for the Amazon Q application.
", "GetDataSourceResponse$description": "The description for the data source connector.
", "GetIndexResponse$description": "The description for the Amazon Q index.
", "UpdateApplicationRequest$description": "A description for the Amazon Q application.
", "UpdateDataSourceRequest$description": "The description of the data source connector.
", "UpdateIndexRequest$description": "The description of the Amazon Q index.
" } }, "Document": { "base": "A document in an Amazon Q application.
", "refs": { "Documents$member": null } }, "DocumentAttribute": { "base": "A document attribute or metadata field.
", "refs": { "AttributeFilter$containsAll": "Returns true when a document contains all the specified document attributes or metadata fields.
Returns true when a document contains any of the specified document attributes or metadata fields.
Performs an equals operation on two document attributes or metadata fields.
", "AttributeFilter$greaterThan": "Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. 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 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 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 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.
", "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 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.
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 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 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 web experience responses.
" } }, "DocumentContent": { "base": "The contents of a document.
", "refs": { "Document$content": "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 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 Kendra 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": { "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 index.
" } }, "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.
" } }, "EligibleDataSource": { "base": "The identifier of the data source Amazon Q will generate responses from.
", "refs": { "EligibleDataSources$member": null } }, "EligibleDataSources": { "base": null, "refs": { "ContentRetrievalRule$eligibleDataSources": "Specifies data sources in a Amazon Q application to use for content generation.
" } }, "EncryptionConfiguration": { "base": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.
", "refs": { "CreateApplicationRequest$encryptionConfiguration": "The identifier of the KMS key that is used to encrypt your data. Amazon Q 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 doesn't support asymmetric keys.
" } }, "ErrorCode": { "base": null, "refs": { "ErrorDetail$errorCode": "The code associated with the data source sync error.
" } }, "ErrorDetail": { "base": "Provides information about a data source sync error.
", "refs": { "AttachmentOutput$error": "An error associated with a file uploaded during chat.
", "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 data source sync error.
", "InternalServerException$message": null, "LicenseNotFoundException$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.
" } }, "FailedDocument": { "base": "A list of documents that could not be removed from an Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
", "refs": { "FailedDocuments$member": null } }, "FailedDocuments": { "base": null, "refs": { "BatchDeleteDocumentResponse$failedDocuments": "A list of documents that couldn't be removed from the Amazon Q 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 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.
" } }, "GetApplicationRequest": { "base": null, "refs": { } }, "GetApplicationResponse": { "base": null, "refs": { } }, "GetChatControlsConfigurationRequest": { "base": null, "refs": { } }, "GetChatControlsConfigurationResponse": { "base": null, "refs": { } }, "GetDataSourceRequest": { "base": null, "refs": { } }, "GetDataSourceResponse": { "base": null, "refs": { } }, "GetGroupRequest": { "base": null, "refs": { } }, "GetGroupResponse": { "base": null, "refs": { } }, "GetIndexRequest": { "base": null, "refs": { } }, "GetIndexResponse": { "base": null, "refs": { } }, "GetPluginRequest": { "base": null, "refs": { } }, "GetPluginResponse": { "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": { } }, "GroupMembers": { "base": "A list of users or sub groups that belong to a group. This is for generating Amazon Q chat results only from document a user has access to.
", "refs": { "PutGroupRequest$groupMembers": null } }, "GroupName": { "base": null, "refs": { "DeleteGroupRequest$groupName": "The name of the group you want to delete.
", "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\".
If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
" } }, "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.
" } }, "HookConfiguration": { "base": "Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.
You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q 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$postExtractionHookConfiguration": null, "DocumentEnrichmentConfiguration$preExtractionHookConfiguration": null } }, "Index": { "base": "Summary information for your Amazon Q index.
", "refs": { "Indices$member": null } }, "IndexArn": { "base": null, "refs": { "CreateIndexResponse$indexArn": "The Amazon Resource Name (ARN) of an Amazon Q index.
", "GetIndexResponse$indexArn": "The Amazon Resource Name (ARN) of the Amazon Q 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 index.
", "UpdateIndexRequest$capacityConfiguration": "The storage capacity units you want to provision for your Amazon Q 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 index.
" } }, "IndexId": { "base": null, "refs": { "BatchDeleteDocumentRequest$indexId": "The identifier of the Amazon Q index that contains the documents to delete.
", "BatchPutDocumentRequest$indexId": "The identifier of the Amazon Q index to add the documents to.
", "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 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 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.
", "GetGroupRequest$indexId": "The identifier of the index the group is attached to.
", "GetIndexRequest$indexId": "The identifier of the Amazon Q index you want information on.
", "GetIndexResponse$indexId": "The identifier of the Amazon Q index.
", "Index$indexId": "The identifier for the index.
", "ListDataSourceSyncJobsRequest$indexId": "The identifier of the index used with the Amazon Q 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 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 data source connector.
", "UpdateDataSourceRequest$indexId": "The identifier of the index attached to the data source connector.
", "UpdateIndexRequest$indexId": "The identifier of the Amazon Q 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 index.
", "GetIndexResponse$displayName": "The name of the Amazon Q 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 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.
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.
" } }, "Integer": { "base": null, "refs": { "ActionReviewPayloadField$displayOrder": "The display order of fields in a payload.
", "SourceAttribution$citationNumber": "The number attached to a citation in an Amazon Q 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 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 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 doesn't support asymmetric keys.
" } }, "LambdaArn": { "base": null, "refs": { "HookConfiguration$lambdaArn": "The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).
" } }, "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": { } }, "ListConversationsRequest": { "base": null, "refs": { } }, "ListConversationsResponse": { "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": { } }, "ListPluginsRequest": { "base": null, "refs": { } }, "ListPluginsResponse": { "base": null, "refs": { } }, "ListRetrieversRequest": { "base": null, "refs": { } }, "ListRetrieversResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListWebExperiencesRequest": { "base": null, "refs": { } }, "ListWebExperiencesResponse": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "DocumentAttributeValue$longValue": "A long integer value.
" } }, "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 applications to return.
" } }, "MaxResultsIntegerForListConversations": { "base": null, "refs": { "ListConversationsRequest$maxResults": "The maximum number of Amazon Q conversations to return.
" } }, "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.
" } }, "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.
" } }, "MaxResultsIntegerForListWebExperiencesRequest": { "base": null, "refs": { "ListWebExperiencesRequest$maxResults": "The maximum number of Amazon Q Web Experiences to return.
" } }, "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.
" } }, "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": { "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 web experience.
", "refs": { "Messages$member": null } }, "MessageBody": { "base": null, "refs": { "Message$body": "The content of the Amazon Q web experience message.
" } }, "MessageId": { "base": null, "refs": { "ChatSyncInput$parentMessageId": "The identifier of the previous end user text input message in a conversation.
", "ChatSyncOutput$systemMessageId": "The identifier of an Amazon Q AI generated message within the conversation.
", "ChatSyncOutput$userMessageId": "The identifier of an Amazon Q end user text input message within the conversation.
" } }, "MessageType": { "base": null, "refs": { "Message$type": "The type of Amazon Q 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.
" } }, "MetricValue": { "base": null, "refs": { "DataSourceSyncJobMetrics$documentsAdded": "The current count of documents added from 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$documentsModified": "The current count of documents modified in 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 index.
", "refs": { "RetrieverConfiguration$nativeIndexConfiguration": "Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.
" } }, "NextToken": { "base": null, "refs": { "GetChatControlsConfigurationRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.
If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
", "ListConversationsRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
If the response is truncated, Amazon Q 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 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 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 returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q data source connectors.
If the response is truncated, Amazon Q 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 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 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 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 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 returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q indices.
", "ListIndicesResponse$nextToken": "If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of indexes.
", "ListMessagesRequest$nextToken": "If the number of retrievers returned exceeds maxResults, Amazon Q returns a next token as a pagination token to retrieve the next set of messages.
If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
", "ListPluginsRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q 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 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 returns a next token as a pagination token to retrieve the next set of retrievers.
If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of retrievers.
", "ListWebExperiencesRequest$nextToken": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
" } }, "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.
" } }, "Plugin": { "base": "Information about an Amazon Q 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 plugin.
", "refs": { "CreatePluginRequest$authConfiguration": null, "GetPluginResponse$authConfiguration": null, "UpdatePluginRequest$authConfiguration": "The authentication configuration the plugin is using.
" } }, "PluginId": { "base": null, "refs": { "ActionExecution$pluginId": "The identifier of the plugin the action is attached to.
", "ActionReview$pluginId": "The identifier of the plugin associated with the action review.
", "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.
", "Plugin$pluginId": "The identifier of the plugin.
", "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.
", "CreatePluginRequest$type": "The type of plugin you want to create.
", "GetPluginResponse$type": "The type of the plugin.
", "Plugin$type": "The type of the plugin.
" } }, "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 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.
" } }, "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.
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.
" } }, "ResourceNotFoundException": { "base": "The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
", "refs": { } }, "ResponseScope": { "base": null, "refs": { "GetChatControlsConfigurationResponse$responseScope": "The response scope configured for a Amazon Q 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 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 application is configured.
", "refs": { "CreateRetrieverRequest$configuration": null, "GetRetrieverResponse$configuration": null, "UpdateRetrieverRequest$configuration": null } }, "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 application.
", "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 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.
", "CreateDataSourceRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
", "CreateRetrieverRequest$roleArn": "The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
", "GetApplicationResponse$roleArn": "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.
", "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 ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
", "SamlConfiguration$roleArn": "The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.
", "UpdateApplicationRequest$roleArn": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q 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.
" } }, "Rule": { "base": "Guardrail rules for an Amazon Q application. Amazon Q 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 fo rule.
" } }, "Rules": { "base": null, "refs": { "TopicConfiguration$rules": "Rules defined for a topic configuration.
" } }, "S3": { "base": "Information required for Amazon Q to find a specific file in an Amazon S3 bucket.
", "refs": { "DocumentContent$s3": "The path to the document in an Amazon S3 bucket.
" } }, "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$userGroupAttribute": "The group attribute name in your IdP that maps to user groups.
", "SamlConfiguration$userIdAttribute": "The user attribute name in your IdP that maps to the user email.
" } }, "SamlConfiguration": { "base": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.
", "refs": { "WebExperienceAuthConfiguration$samlConfiguration": null } }, "SamlMetadataXML": { "base": null, "refs": { "SamlConfiguration$metadataXML": "The metadata XML that your IdP generated.
" } }, "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.
" } }, "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 to connect to the data source.
" } }, "ServiceQuotaExceededException": { "base": "You have exceeded the set limits for your Amazon Q service.
", "refs": { } }, "SourceAttribution": { "base": "The documents used to generate an Amazon Q web experience response.
", "refs": { "SourceAttributions$member": null } }, "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 web experience message.
" } }, "StartDataSourceSyncJobRequest": { "base": null, "refs": { } }, "StartDataSourceSyncJobResponse": { "base": null, "refs": { } }, "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.
", "ChatSyncOutput$systemMessage": "An AI-generated message in a conversation.
", "ConflictException$resourceId": "The identifier of the resource affected.
", "ConflictException$resourceType": "The type of the resource affected.
", "CreateUserRequest$userId": "The user emails attached to a user mapping.
", "DataSource$type": "The type of the Amazon Q 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.
", "DocumentAttributeConfiguration$name": "The name of the document attribute.
", "DocumentAttributeStringListValue$member": null, "GetDataSourceResponse$type": "The type of the data source connector. For example, S3.
The user email address attached to the user.
", "Message$messageId": "The identifier of the Amazon Q web experience message.
", "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$snippet": "The content extract from the document on which the generated response is based.
", "SourceAttribution$title": "The title of the document which is the source for the Amazon Q generated response.
", "SourceAttribution$url": "The URL of the document which is the source for the Amazon Q generated response.
", "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$message": "A message about the validation exception.
", "ValidationExceptionField$name": "The field name where the invalid entry was detected.
" } }, "SubnetId": { "base": null, "refs": { "SubnetIds$member": null } }, "SubnetIds": { "base": null, "refs": { "DataSourceVpcConfiguration$subnetIds": "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.
" } }, "SyncSchedule": { "base": null, "refs": { "CreateDataSourceRequest$syncSchedule": "Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q 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 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.
" } }, "Tag": { "base": "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 application or data source.
", "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of tag keys to remove from the Amazon Q 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 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: _ . : / = + - @.
", "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 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 application or data source.
", "TagResourceRequest$tags": "A list of tag keys to add to the Amazon Q 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.
" } }, "TextSegment": { "base": "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 application was created.
", "Application$updatedAt": "The Unix timestamp when the Amazon Q application was last updated.
", "Conversation$startTime": "The start time of the conversation.
", "DataSource$createdAt": "The Unix timestamp when the Amazon Q data source was created.
", "DataSource$updatedAt": "The Unix timestamp when the Amazon Q data source was last updated.
", "DataSourceSyncJob$endTime": "The Unix timestamp when the synchronization job completed.
", "DataSourceSyncJob$startTime": "The Unix time stamp when the data source synchronization job started.
", "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 application was last updated.
", "GetApplicationResponse$updatedAt": "The Unix timestamp when the Amazon Q application 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 index was created.
", "GetIndexResponse$updatedAt": "The Unix timestamp when the Amazon Q 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 retriever was created.
", "GetWebExperienceResponse$updatedAt": "The Unix timestamp when the data source connector was last updated.
", "GroupStatusDetail$lastUpdatedAt": "The Unix timestamp when the Amazon Q 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$endTime": "The end time of the data source connector sync.
", "ListDataSourceSyncJobsRequest$startTime": "The start 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 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 application was last updated.
", "WebExperience$createdAt": "The Unix timestamp when the Amazon Q application was last updated.
", "WebExperience$updatedAt": "The Unix timestamp when your Amazon Q web experience was updated.
" } }, "Title": { "base": null, "refs": { "Document$title": "The title of the document.
" } }, "TopicConfiguration": { "base": "The topic specific controls configured for an Amazon Q 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 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 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": { } }, "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": { } }, "UpdateUserRequest": { "base": null, "refs": { } }, "UpdateUserResponse": { "base": null, "refs": { } }, "UpdateWebExperienceRequest": { "base": null, "refs": { } }, "UpdateWebExperienceResponse": { "base": null, "refs": { } }, "Url": { "base": null, "refs": { "CreatePluginRequest$serverUrl": "The source URL used for plugin configuration.
", "GetPluginResponse$serverUrl": "The source URL used for plugin configuration.
", "GetWebExperienceResponse$defaultEndpoint": "The endpoint of your Amazon Q web experience.
", "Plugin$serverUrl": "The plugin server URL used for configuration.
", "UpdatePluginRequest$serverUrl": "The source URL used for plugin configuration.
", "WebExperience$defaultEndpoint": "The endpoint URLs for your Amazon Q 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 application.
", "refs": { "CreateUserRequestUserAliasesList$member": null, "UserAliases$member": null } }, "UserAliases": { "base": null, "refs": { "GetUserResponse$userAliases": "A list of user aliases attached to a user.
", "UpdateUserRequest$userAliasesToDelete": "The user aliases attached to the user id that are to be deleted.
", "UpdateUserRequest$userAliasesToUpdate": "The user aliases attached to the user id that are to be updated.
", "UpdateUserResponse$userAliasesAdded": "The user aliases that have been to be added to a user id.
", "UpdateUserResponse$userAliasesDeleted": "The user aliases that have been deleted from a user id.
", "UpdateUserResponse$userAliasesUpdated": "The user aliases attached to a user id that have been updated.
" } }, "UserGroups": { "base": null, "refs": { "ChatSyncInput$userGroups": "The groups that a user associated with the chat input belongs to.
", "UsersAndGroups$userGroups": "The user groups associated with a topic control rule.
" } }, "UserId": { "base": null, "refs": { "ChatSyncInput$userId": "The identifier of the user attached to the chat input.
", "DeleteConversationRequest$userId": "The identifier of the user who is deleting the conversation.
", "ListConversationsRequest$userId": "The identifier of the user involved in the Amazon Q web experience conversation.
", "ListMessagesRequest$userId": "The identifier of the user involved in the Amazon Q web experience conversation.
", "PrincipalUser$id": "The identifier of the user.
", "PutFeedbackRequest$userId": "The identifier of the user giving the feedback.
" } }, "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.
" } }, "UsersAndGroups": { "base": "Provides information about users and groups associated with a topic control rule.
", "refs": { "Rule$excludedUsersAndGroups": "Users and groups to be excluded from a rule.
", "Rule$includedUsersAndGroups": "Users and groups to be included in a rule.
" } }, "ValidationException": { "base": "The input doesn't meet the constraints set by the Amazon Q service. Provide the correct input and try again.
", "refs": { } }, "ValidationExceptionField": { "base": "The input failed to meet the constraints specified by Amazon Q 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.
Provides information for an Amazon Q web experience.
", "refs": { "WebExperiences$member": null } }, "WebExperienceArn": { "base": null, "refs": { "CreateWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of an Amazon Q web experience.
", "GetWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
" } }, "WebExperienceAuthConfiguration": { "base": "Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.
", "refs": { "GetWebExperienceResponse$authenticationConfiguration": "The authentication configuration information for your Amazon Q web experience.
", "UpdateWebExperienceRequest$authenticationConfiguration": "The authentication configuration of the Amazon Q web experience.
" } }, "WebExperienceId": { "base": null, "refs": { "CreateWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q web experience.
", "DeleteWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience being deleted.
", "GetWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience.
", "GetWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q web experience.
", "UpdateWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience.
", "WebExperience$webExperienceId": "The identifier of your Amazon Q web experience.
" } }, "WebExperienceSamplePromptsControlMode": { "base": null, "refs": { "CreateWebExperienceRequest$samplePromptsControlMode": "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 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 web experience.
" } }, "WebExperienceSubtitle": { "base": null, "refs": { "CreateWebExperienceRequest$subtitle": "A subtitle to personalize your Amazon Q web experience.
", "GetWebExperienceResponse$subtitle": "The subtitle for your Amazon Q web experience.
", "UpdateWebExperienceRequest$subtitle": "The subtitle of the Amazon Q web experience.
" } }, "WebExperienceTitle": { "base": null, "refs": { "CreateWebExperienceRequest$title": "The title for your Amazon Q web experience.
", "GetWebExperienceResponse$title": "The title for your Amazon Q web experience.
", "UpdateWebExperienceRequest$title": "The title of the Amazon Q web experience.
" } }, "WebExperienceWelcomeMessage": { "base": null, "refs": { "CreateWebExperienceRequest$welcomeMessage": "The customized welcome message for end users of an Amazon Q web experience.
", "GetWebExperienceResponse$welcomeMessage": "The customized welcome message for end users of an Amazon Q web experience.
", "UpdateWebExperienceRequest$welcomeMessage": "A customized welcome message for an end user in an Amazon Q web experience.
" } }, "WebExperiences": { "base": null, "refs": { "ListWebExperiencesResponse$webExperiences": "An array of summary information for one or more Amazon Q experiences.
" } } } }