{ "version":"2.0", "metadata":{ "apiVersion":"2023-11-27", "endpointPrefix":"qbusiness", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"QBusiness", "serviceId":"QBusiness", "signatureVersion":"v4", "signingName":"qbusiness", "uid":"qbusiness-2023-11-27" }, "operations":{ "BatchDeleteDocument":{ "name":"BatchDeleteDocument", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices/{indexId}/documents/delete", "responseCode":200 }, "input":{"shape":"BatchDeleteDocumentRequest"}, "output":{"shape":"BatchDeleteDocumentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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":{ "name":"BatchPutDocument", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices/{indexId}/documents", "responseCode":200 }, "input":{"shape":"BatchPutDocumentRequest"}, "output":{"shape":"BatchPutDocumentResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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":{ "name":"ChatSync", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/conversations?sync", "responseCode":200 }, "input":{"shape":"ChatSyncInput"}, "output":{"shape":"ChatSyncOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"LicenseNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Starts or continues a non-streaming Amazon Q conversation.

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/applications", "responseCode":200 }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates an Amazon Q application.

", "idempotent":true }, "CreateDataSource":{ "name":"CreateDataSource", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", "responseCode":200 }, "input":{"shape":"CreateDataSourceRequest"}, "output":{"shape":"CreateDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "CreateIndex":{ "name":"CreateIndex", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices", "responseCode":200 }, "input":{"shape":"CreateIndexRequest"}, "output":{"shape":"CreateIndexResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

" }, "CreatePlugin":{ "name":"CreatePlugin", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/plugins", "responseCode":200 }, "input":{"shape":"CreatePluginRequest"}, "output":{"shape":"CreatePluginResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates an Amazon Q plugin.

", "idempotent":true }, "CreateRetriever":{ "name":"CreateRetriever", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/retrievers", "responseCode":200 }, "input":{"shape":"CreateRetrieverRequest"}, "output":{"shape":"CreateRetrieverResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Adds a retriever to your Amazon Q application.

" }, "CreateUser":{ "name":"CreateUser", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/users", "responseCode":200 }, "input":{"shape":"CreateUserRequest"}, "output":{"shape":"CreateUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

", "idempotent":true }, "CreateWebExperience":{ "name":"CreateWebExperience", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/experiences", "responseCode":200 }, "input":{"shape":"CreateWebExperienceRequest"}, "output":{"shape":"CreateWebExperienceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Creates an Amazon Q web experience.

" }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}", "responseCode":200 }, "input":{"shape":"DeleteApplicationRequest"}, "output":{"shape":"DeleteApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes an Amazon Q application.

", "idempotent":true }, "DeleteChatControlsConfiguration":{ "name":"DeleteChatControlsConfiguration", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/chatcontrols", "responseCode":200 }, "input":{"shape":"DeleteChatControlsConfigurationRequest"}, "output":{"shape":"DeleteChatControlsConfigurationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes chat controls configured for an existing Amazon Q application.

", "idempotent":true }, "DeleteConversation":{ "name":"DeleteConversation", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/conversations/{conversationId}", "responseCode":200 }, "input":{"shape":"DeleteConversationRequest"}, "output":{"shape":"DeleteConversationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"LicenseNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes an Amazon Q web experience conversation.

", "idempotent":true }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "responseCode":200 }, "input":{"shape":"DeleteDataSourceRequest"}, "output":{"shape":"DeleteDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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`.

", "idempotent":true }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", "responseCode":200 }, "input":{"shape":"DeleteGroupRequest"}, "output":{"shape":"DeleteGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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`.

", "idempotent":true }, "DeleteIndex":{ "name":"DeleteIndex", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/indices/{indexId}", "responseCode":200 }, "input":{"shape":"DeleteIndexRequest"}, "output":{"shape":"DeleteIndexResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes an Amazon Q index.

", "idempotent":true }, "DeletePlugin":{ "name":"DeletePlugin", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/plugins/{pluginId}", "responseCode":200 }, "input":{"shape":"DeletePluginRequest"}, "output":{"shape":"DeletePluginResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes an Amazon Q plugin.

", "idempotent":true }, "DeleteRetriever":{ "name":"DeleteRetriever", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", "responseCode":200 }, "input":{"shape":"DeleteRetrieverRequest"}, "output":{"shape":"DeleteRetrieverResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes the retriever used by an Amazon Q application.

", "idempotent":true }, "DeleteUser":{ "name":"DeleteUser", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/users/{userId}", "responseCode":200 }, "input":{"shape":"DeleteUserRequest"}, "output":{"shape":"DeleteUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes a user by email id.

", "idempotent":true }, "DeleteWebExperience":{ "name":"DeleteWebExperience", "http":{ "method":"DELETE", "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", "responseCode":200 }, "input":{"shape":"DeleteWebExperienceRequest"}, "output":{"shape":"DeleteWebExperienceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Deletes an Amazon Q web experience.

", "idempotent":true }, "GetApplication":{ "name":"GetApplication", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}", "responseCode":200 }, "input":{"shape":"GetApplicationRequest"}, "output":{"shape":"GetApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing Amazon Q application.

" }, "GetChatControlsConfiguration":{ "name":"GetChatControlsConfiguration", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/chatcontrols", "responseCode":200 }, "input":{"shape":"GetChatControlsConfigurationRequest"}, "output":{"shape":"GetChatControlsConfigurationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an chat controls configured for an existing Amazon Q application.

" }, "GetDataSource":{ "name":"GetDataSource", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "responseCode":200 }, "input":{"shape":"GetDataSourceRequest"}, "output":{"shape":"GetDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing Amazon Q data source connector.

" }, "GetGroup":{ "name":"GetGroup", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}/groups/{groupName}", "responseCode":200 }, "input":{"shape":"GetGroupRequest"}, "output":{"shape":"GetGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Describes a group by group name.

" }, "GetIndex":{ "name":"GetIndex", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}", "responseCode":200 }, "input":{"shape":"GetIndexRequest"}, "output":{"shape":"GetIndexResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing Amazon Q index.

" }, "GetPlugin":{ "name":"GetPlugin", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/plugins/{pluginId}", "responseCode":200 }, "input":{"shape":"GetPluginRequest"}, "output":{"shape":"GetPluginResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing Amazon Q plugin.

" }, "GetRetriever":{ "name":"GetRetriever", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", "responseCode":200 }, "input":{"shape":"GetRetrieverRequest"}, "output":{"shape":"GetRetrieverResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing retriever used by an Amazon Q application.

" }, "GetUser":{ "name":"GetUser", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/users/{userId}", "responseCode":200 }, "input":{"shape":"GetUserRequest"}, "output":{"shape":"GetUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Describes the universally unique identifier (UUID) associated with a local user in a data source.

" }, "GetWebExperience":{ "name":"GetWebExperience", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", "responseCode":200 }, "input":{"shape":"GetWebExperienceRequest"}, "output":{"shape":"GetWebExperienceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets information about an existing Amazon Q web experience.

" }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"GET", "requestUri":"/applications", "responseCode":200 }, "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists Amazon Q applications.

" }, "ListConversations":{ "name":"ListConversations", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/conversations", "responseCode":200 }, "input":{"shape":"ListConversationsRequest"}, "output":{"shape":"ListConversationsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"LicenseNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists one or more Amazon Q conversations.

" }, "ListDataSourceSyncJobs":{ "name":"ListDataSourceSyncJobs", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", "responseCode":200 }, "input":{"shape":"ListDataSourceSyncJobsRequest"}, "output":{"shape":"ListDataSourceSyncJobsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Get information about an Amazon Q data source connector synchronization.

" }, "ListDataSources":{ "name":"ListDataSources", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources", "responseCode":200 }, "input":{"shape":"ListDataSourcesRequest"}, "output":{"shape":"ListDataSourcesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the Amazon Q data source connectors that you have created.

" }, "ListDocuments":{ "name":"ListDocuments", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/index/{indexId}/documents", "responseCode":200 }, "input":{"shape":"ListDocumentsRequest"}, "output":{"shape":"ListDocumentsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

A list of documents attached to an index.

" }, "ListGroups":{ "name":"ListGroups", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", "responseCode":200 }, "input":{"shape":"ListGroupsRequest"}, "output":{"shape":"ListGroupsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Provides a list of groups that are mapped to users.

" }, "ListIndices":{ "name":"ListIndices", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/indices", "responseCode":200 }, "input":{"shape":"ListIndicesRequest"}, "output":{"shape":"ListIndicesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the Amazon Q indices you have created.

" }, "ListMessages":{ "name":"ListMessages", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/conversations/{conversationId}", "responseCode":200 }, "input":{"shape":"ListMessagesRequest"}, "output":{"shape":"ListMessagesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"LicenseNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets a list of messages associated with an Amazon Q web experience.

" }, "ListPlugins":{ "name":"ListPlugins", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/plugins", "responseCode":200 }, "input":{"shape":"ListPluginsRequest"}, "output":{"shape":"ListPluginsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists configured Amazon Q plugins.

" }, "ListRetrievers":{ "name":"ListRetrievers", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/retrievers", "responseCode":200 }, "input":{"shape":"ListRetrieversRequest"}, "output":{"shape":"ListRetrieversResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the retriever used by an Amazon Q application.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/v1/tags/{resourceARN}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.

" }, "ListWebExperiences":{ "name":"ListWebExperiences", "http":{ "method":"GET", "requestUri":"/applications/{applicationId}/experiences", "responseCode":200 }, "input":{"shape":"ListWebExperiencesRequest"}, "output":{"shape":"ListWebExperiencesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists one or more Amazon Q Web Experiences.

" }, "PutFeedback":{ "name":"PutFeedback", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", "responseCode":200 }, "input":{"shape":"PutFeedbackRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Enables your end user to to provide feedback on their Amazon Q generated chat responses.

" }, "PutGroup":{ "name":"PutGroup", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/indices/{indexId}/groups", "responseCode":200 }, "input":{"shape":"PutGroupRequest"}, "output":{"shape":"PutGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

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.

", "idempotent":true }, "StartDataSourceSyncJob":{ "name":"StartDataSourceSyncJob", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync", "responseCode":200 }, "input":{"shape":"StartDataSourceSyncJobRequest"}, "output":{"shape":"StartDataSourceSyncJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a `ConflictException`.

" }, "StopDataSourceSyncJob":{ "name":"StopDataSourceSyncJob", "http":{ "method":"POST", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", "responseCode":200 }, "input":{"shape":"StopDataSourceSyncJobRequest"}, "output":{"shape":"StopDataSourceSyncJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Stops an Amazon Q data source connector synchronization job already in progress.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/v1/tags/{resourceARN}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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.

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/v1/tags/{resourceARN}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Removes a tag from an Amazon Q application or a data source.

", "idempotent":true }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}", "responseCode":200 }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates an existing Amazon Q application.

", "idempotent":true }, "UpdateChatControlsConfiguration":{ "name":"UpdateChatControlsConfiguration", "http":{ "method":"PATCH", "requestUri":"/applications/{applicationId}/chatcontrols", "responseCode":200 }, "input":{"shape":"UpdateChatControlsConfigurationRequest"}, "output":{"shape":"UpdateChatControlsConfigurationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates an set of chat controls configured for an existing Amazon Q application.

", "idempotent":true }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "responseCode":200 }, "input":{"shape":"UpdateDataSourceRequest"}, "output":{"shape":"UpdateDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates an existing Amazon Q data source connector.

", "idempotent":true }, "UpdateIndex":{ "name":"UpdateIndex", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/indices/{indexId}", "responseCode":200 }, "input":{"shape":"UpdateIndexRequest"}, "output":{"shape":"UpdateIndexResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates an Amazon Q index.

", "idempotent":true }, "UpdatePlugin":{ "name":"UpdatePlugin", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/plugins/{pluginId}", "responseCode":200 }, "input":{"shape":"UpdatePluginRequest"}, "output":{"shape":"UpdatePluginResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates an Amazon Q plugin.

", "idempotent":true }, "UpdateRetriever":{ "name":"UpdateRetriever", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/retrievers/{retrieverId}", "responseCode":200 }, "input":{"shape":"UpdateRetrieverRequest"}, "output":{"shape":"UpdateRetrieverResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates the retriever used for your Amazon Q application.

", "idempotent":true }, "UpdateUser":{ "name":"UpdateUser", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/users/{userId}", "responseCode":200 }, "input":{"shape":"UpdateUserRequest"}, "output":{"shape":"UpdateUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], "documentation":"

Updates a information associated with a user id.

", "idempotent":true }, "UpdateWebExperience":{ "name":"UpdateWebExperience", "http":{ "method":"PUT", "requestUri":"/applications/{applicationId}/experiences/{webExperienceId}", "responseCode":200 }, "input":{"shape":"UpdateWebExperienceRequest"}, "output":{"shape":"UpdateWebExperienceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates an Amazon Q web experience.

", "idempotent":true } }, "shapes":{ "AccessConfiguration":{ "type":"structure", "required":["accessControls"], "members":{ "accessControls":{ "shape":"AccessControls", "documentation":"

A list of `AccessControlList` objects.

" }, "memberRelation":{ "shape":"MemberRelation", "documentation":"

Describes the member relation within the `AccessControlList` object.

" } }, "documentation":"

Used to configure access permissions for a document.

" }, "AccessControl":{ "type":"structure", "required":["principals"], "members":{ "memberRelation":{ "shape":"MemberRelation", "documentation":"

Describes the member relation within a principal list.

" }, "principals":{ "shape":"Principals", "documentation":"

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`.

" } }, "documentation":"

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`.

" }, "AccessControls":{ "type":"list", "member":{"shape":"AccessControl"} }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ActionExecution":{ "type":"structure", "required":[ "payload", "payloadFieldNameSeparator", "pluginId" ], "members":{ "payload":{ "shape":"ActionExecutionPayload", "documentation":"

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.

" }, "payloadFieldNameSeparator":{ "shape":"ActionPayloadFieldNameSeparator", "documentation":"

A string used to retain information about the hierarchical contexts within an action execution event payload.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin the action is attached to.

" } }, "documentation":"

Performs an Amazon Q plugin action during a non-streaming chat conversation.

" }, "ActionExecutionPayload":{ "type":"map", "key":{"shape":"ActionPayloadFieldKey"}, "value":{"shape":"ActionExecutionPayloadField"} }, "ActionExecutionPayloadField":{ "type":"structure", "required":["value"], "members":{ "value":{ "shape":"ActionPayloadFieldValue", "documentation":"

The content of a user input field in an plugin action execution payload.

" } }, "documentation":"

A user input field in an plugin action execution payload.

" }, "ActionPayloadFieldKey":{ "type":"string", "min":1 }, "ActionPayloadFieldNameSeparator":{ "type":"string", "max":1, "min":1 }, "ActionPayloadFieldType":{ "type":"string", "enum":[ "STRING", "NUMBER", "ARRAY", "BOOLEAN" ] }, "ActionPayloadFieldValue":{ "type":"structure", "members":{ }, "document":true }, "ActionReview":{ "type":"structure", "members":{ "payload":{ "shape":"ActionReviewPayload", "documentation":"

Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.

" }, "payloadFieldNameSeparator":{ "shape":"ActionPayloadFieldNameSeparator", "documentation":"

A string used to retain information about the hierarchical contexts within an action review payload.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin associated with the action review.

" }, "pluginType":{ "shape":"PluginType", "documentation":"

The type of plugin.

" } }, "documentation":"

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.

" }, "ActionReviewPayload":{ "type":"map", "key":{"shape":"ActionPayloadFieldKey"}, "value":{"shape":"ActionReviewPayloadField"} }, "ActionReviewPayloadField":{ "type":"structure", "members":{ "allowedValues":{ "shape":"ActionReviewPayloadFieldAllowedValues", "documentation":"

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.

" }, "displayName":{ "shape":"String", "documentation":"

The name of the field.

" }, "displayOrder":{ "shape":"Integer", "documentation":"

The display order of fields in a payload.

" }, "required":{ "shape":"Boolean", "documentation":"

Information about whether the field is required.

" }, "type":{ "shape":"ActionPayloadFieldType", "documentation":"

The type of field.

" }, "value":{ "shape":"ActionPayloadFieldValue", "documentation":"

The field value.

" } }, "documentation":"

A user input field in an plugin action review payload.

" }, "ActionReviewPayloadFieldAllowedValue":{ "type":"structure", "members":{ "displayValue":{ "shape":"ActionPayloadFieldValue", "documentation":"

The name of the field.

" }, "value":{ "shape":"ActionPayloadFieldValue", "documentation":"

The field value.

" } }, "documentation":"

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.

" }, "ActionReviewPayloadFieldAllowedValues":{ "type":"list", "member":{"shape":"ActionReviewPayloadFieldAllowedValue"} }, "AmazonResourceName":{ "type":"string", "max":1011, "min":1 }, "Application":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier for the Amazon Q application.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was created.

" }, "displayName":{ "shape":"ApplicationName", "documentation":"

The name of the Amazon Q application.

" }, "status":{ "shape":"ApplicationStatus", "documentation":"

The status of the Amazon Q application. The application is ready to use when the status is `ACTIVE`.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" } }, "documentation":"

Summary information for an Amazon Q application.

" }, "ApplicationArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "ApplicationId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "ApplicationName":{ "type":"string", "max":1000, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" }, "ApplicationStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING" ] }, "Applications":{ "type":"list", "member":{"shape":"Application"} }, "AppliedAttachmentsConfiguration":{ "type":"structure", "members":{ "attachmentsControlMode":{ "shape":"AttachmentsControlMode", "documentation":"

Information about whether file upload during chat functionality is activated for your application.

" } }, "documentation":"

Configuration information about the file upload during chat feature for your application.

" }, "AttachmentInput":{ "type":"structure", "required":[ "data", "name" ], "members":{ "data":{ "shape":"Blob", "documentation":"

The data contained within the uploaded file.

" }, "name":{ "shape":"AttachmentName", "documentation":"

The name of the file.

" } }, "documentation":"

A file directly uploaded into a web experience chat.

" }, "AttachmentName":{ "type":"string", "max":1000, "min":1, "pattern":"^\\P{C}*$" }, "AttachmentOutput":{ "type":"structure", "members":{ "error":{ "shape":"ErrorDetail", "documentation":"

An error associated with a file uploaded during chat.

" }, "name":{ "shape":"AttachmentName", "documentation":"

The name of a file uploaded during chat.

" }, "status":{ "shape":"AttachmentStatus", "documentation":"

The status of a file uploaded during chat.

" } }, "documentation":"

The details of a file uploaded during chat.

" }, "AttachmentStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED" ] }, "AttachmentsConfiguration":{ "type":"structure", "required":["attachmentsControlMode"], "members":{ "attachmentsControlMode":{ "shape":"AttachmentsControlMode", "documentation":"

Status information about whether file upload functionality is activated or deactivated for your end user.

" } }, "documentation":"

Configuration information for the file upload during chat feature.

" }, "AttachmentsControlMode":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "AttachmentsInput":{ "type":"list", "member":{"shape":"AttachmentInput"}, "min":1 }, "AttachmentsOutput":{ "type":"list", "member":{"shape":"AttachmentOutput"} }, "AttributeFilter":{ "type":"structure", "members":{ "andAllFilters":{ "shape":"AttributeFilters", "documentation":"

Performs a logical `AND` operation on all supplied filters.

" }, "containsAll":{ "shape":"DocumentAttribute", "documentation":"

Returns `true` when a document contains all the specified document attributes or metadata fields.

" }, "containsAny":{ "shape":"DocumentAttribute", "documentation":"

Returns `true` when a document contains any of the specified document attributes or metadata fields.

" }, "equalsTo":{ "shape":"DocumentAttribute", "documentation":"

Performs an equals operation on two document attributes or metadata fields.

" }, "greaterThan":{ "shape":"DocumentAttribute", "documentation":"

Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type `Date` or `Long`.

" }, "greaterThanOrEquals":{ "shape":"DocumentAttribute", "documentation":"

Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type `Date` or `Long`.

" }, "lessThan":{ "shape":"DocumentAttribute", "documentation":"

Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type `Date` or `Long`.

" }, "lessThanOrEquals":{ "shape":"DocumentAttribute", "documentation":"

Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type `Date` or `Long`.

" }, "notFilter":{ "shape":"AttributeFilter", "documentation":"

Performs a logical `NOT` operation on all supplied filters.

" }, "orAllFilters":{ "shape":"AttributeFilters", "documentation":"

Performs a logical `OR` operation on all supplied filters.

" } }, "documentation":"

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

" }, "AttributeFilters":{ "type":"list", "member":{"shape":"AttributeFilter"} }, "AttributeType":{ "type":"string", "enum":[ "STRING", "STRING_LIST", "NUMBER", "DATE" ] }, "AttributeValueOperator":{ "type":"string", "enum":["DELETE"] }, "BasicAuthConfiguration":{ "type":"structure", "required":[ "roleArn", "secretArn" ], "members":{ "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

" }, "secretArn":{ "shape":"SecretArn", "documentation":"

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

" } }, "documentation":"

Information about the basic authentication credentials used to configure a plugin.

" }, "BatchDeleteDocumentRequest":{ "type":"structure", "required":[ "applicationId", "documents", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "dataSourceSyncId":{ "shape":"ExecutionId", "documentation":"

The identifier of the data source sync during which the documents were deleted.

" }, "documents":{ "shape":"DeleteDocuments", "documentation":"

Documents deleted from the Amazon Q index.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index that contains the documents to delete.

", "location":"uri", "locationName":"indexId" } } }, "BatchDeleteDocumentResponse":{ "type":"structure", "members":{ "failedDocuments":{ "shape":"FailedDocuments", "documentation":"

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.

" } } }, "BatchPutDocumentRequest":{ "type":"structure", "required":[ "applicationId", "documents", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "dataSourceSyncId":{ "shape":"ExecutionId", "documentation":"

The identifier of the data source sync during which the documents were added.

" }, "documents":{ "shape":"Documents", "documentation":"

One or more documents to add to the index.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index to add the documents to.

", "location":"uri", "locationName":"indexId" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

" } } }, "BatchPutDocumentResponse":{ "type":"structure", "members":{ "failedDocuments":{ "shape":"FailedDocuments", "documentation":"

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.

" } } }, "Blob":{"type":"blob"}, "BlockedPhrase":{ "type":"string", "max":36, "min":0, "pattern":"^\\P{C}*$" }, "BlockedPhrases":{ "type":"list", "member":{"shape":"BlockedPhrase"}, "max":5, "min":0 }, "BlockedPhrasesConfiguration":{ "type":"structure", "members":{ "blockedPhrases":{ "shape":"BlockedPhrases", "documentation":"

A list of phrases blocked from a Amazon Q web experience chat.

" }, "systemMessageOverride":{ "shape":"SystemMessageOverride", "documentation":"

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

" } }, "documentation":"

Provides information about the phrases blocked from chat by your chat control configuration.

" }, "BlockedPhrasesConfigurationUpdate":{ "type":"structure", "members":{ "blockedPhrasesToCreateOrUpdate":{ "shape":"BlockedPhrases", "documentation":"

Creates or updates a blocked phrases configuration in your Amazon Q application.

" }, "blockedPhrasesToDelete":{ "shape":"BlockedPhrases", "documentation":"

Deletes a blocked phrases configuration in your Amazon Q application.

" }, "systemMessageOverride":{ "shape":"SystemMessageOverride", "documentation":"

The configured custom message displayed to your end user when they use blocked phrase during chat.

" } }, "documentation":"

Updates a blocked phrases configuration in your Amazon Q application.

" }, "Boolean":{ "type":"boolean", "box":true }, "ChatSyncInput":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "actionExecution":{ "shape":"ActionExecution", "documentation":"

A request from an end user to perform an Amazon Q plugin action.

" }, "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the Amazon Q conversation.

", "location":"uri", "locationName":"applicationId" }, "attachments":{ "shape":"AttachmentsInput", "documentation":"

A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

" }, "attributeFilter":{ "shape":"AttributeFilter", "documentation":"

Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify a chat request.

", "idempotencyToken":true }, "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the Amazon Q conversation.

" }, "parentMessageId":{ "shape":"MessageId", "documentation":"

The identifier of the previous end user text input message in a conversation.

" }, "userGroups":{ "shape":"UserGroups", "documentation":"

The groups that a user associated with the chat input belongs to.

", "location":"querystring", "locationName":"userGroups" }, "userId":{ "shape":"UserId", "documentation":"

The identifier of the user attached to the chat input.

", "location":"querystring", "locationName":"userId" }, "userMessage":{ "shape":"UserMessage", "documentation":"

A end user message in a conversation.

" } } }, "ChatSyncOutput":{ "type":"structure", "members":{ "actionReview":{ "shape":"ActionReview", "documentation":"

A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.

" }, "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the Amazon Q conversation.

" }, "failedAttachments":{ "shape":"AttachmentsOutput", "documentation":"

A list of files which failed to upload during chat.

" }, "sourceAttributions":{ "shape":"SourceAttributions", "documentation":"

The source documents used to generate the conversation response.

" }, "systemMessage":{ "shape":"String", "documentation":"

An AI-generated message in a conversation.

" }, "systemMessageId":{ "shape":"MessageId", "documentation":"

The identifier of an Amazon Q AI generated message within the conversation.

" }, "userMessageId":{ "shape":"MessageId", "documentation":"

The identifier of an Amazon Q end user text input message within the conversation.

" } } }, "ClientToken":{ "type":"string", "max":100, "min":1 }, "ConflictException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message describing a `ConflictException`.

" }, "resourceId":{ "shape":"String", "documentation":"

The identifier of the resource affected.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of the resource affected.

" } }, "documentation":"

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.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ContentBlockerRule":{ "type":"structure", "members":{ "systemMessageOverride":{ "shape":"SystemMessageOverride", "documentation":"

The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

" } }, "documentation":"

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.

" }, "ContentRetrievalRule":{ "type":"structure", "members":{ "eligibleDataSources":{ "shape":"EligibleDataSources", "documentation":"

Specifies data sources in a Amazon Q application to use for content generation.

" } }, "documentation":"

Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.

" }, "ContentType":{ "type":"string", "enum":[ "PDF", "HTML", "MS_WORD", "PLAIN_TEXT", "PPT", "RTF", "XML", "XSLT", "MS_EXCEL", "CSV", "JSON", "MD" ] }, "Conversation":{ "type":"structure", "members":{ "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the Amazon Q conversation.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

The start time of the conversation.

" }, "title":{ "shape":"ConversationTitle", "documentation":"

The title of the conversation.

" } }, "documentation":"

A conversation in an Amazon Q application.

" }, "ConversationId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "ConversationTitle":{"type":"string"}, "Conversations":{ "type":"list", "member":{"shape":"Conversation"} }, "CreateApplicationRequest":{ "type":"structure", "required":[ "displayName", "roleArn" ], "members":{ "attachmentsConfiguration":{ "shape":"AttachmentsConfiguration", "documentation":"

An option to allow end users to upload files directly during chat.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify the request to create your Amazon Q application.

", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"

A description for the Amazon Q application.

" }, "displayName":{ "shape":"ApplicationName", "documentation":"

A name for the Amazon Q application.

" }, "encryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" } } }, "CreateApplicationResponse":{ "type":"structure", "members":{ "applicationArn":{ "shape":"ApplicationArn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application.

" }, "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

" } } }, "CreateDataSourceRequest":{ "type":"structure", "required":[ "applicationId", "configuration", "displayName", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application the data source will be attached to.

", "location":"uri", "locationName":"applicationId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

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.

", "idempotencyToken":true }, "configuration":{ "shape":"DataSourceConfiguration", "documentation":"

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

" }, "description":{ "shape":"Description", "documentation":"

A description for the data source connector.

" }, "displayName":{ "shape":"DataSourceName", "documentation":"

A name for the data source connector.

" }, "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index that you want to use with the data source connector.

", "location":"uri", "locationName":"indexId" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" }, "syncSchedule":{ "shape":"SyncSchedule", "documentation":"

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.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" }, "vpcConfiguration":{ "shape":"DataSourceVpcConfiguration", "documentation":"

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.

" } } }, "CreateDataSourceResponse":{ "type":"structure", "members":{ "dataSourceArn":{ "shape":"DataSourceArn", "documentation":"

The Amazon Resource Name (ARN) of a data source in an Amazon Q application.

" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

" } } }, "CreateIndexRequest":{ "type":"structure", "required":[ "applicationId", "displayName" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the index.

", "location":"uri", "locationName":"applicationId" }, "capacityConfiguration":{ "shape":"IndexCapacityConfiguration", "documentation":"

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

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.

", "idempotencyToken":true }, "description":{ "shape":"Description", "documentation":"

A description for the Amazon Q index.

" }, "displayName":{ "shape":"IndexName", "documentation":"

A name for the Amazon Q index.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" } } }, "CreateIndexResponse":{ "type":"structure", "members":{ "indexArn":{ "shape":"IndexArn", "documentation":"

The Amazon Resource Name (ARN) of an Amazon Q index.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier for the Amazon Q index.

" } } }, "CreatePluginRequest":{ "type":"structure", "required":[ "applicationId", "authConfiguration", "displayName", "serverUrl", "type" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application that will contain the plugin.

", "location":"uri", "locationName":"applicationId" }, "authConfiguration":{"shape":"PluginAuthConfiguration"}, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify the request to create your Amazon Q plugin.

", "idempotencyToken":true }, "displayName":{ "shape":"PluginName", "documentation":"

A the name for your plugin.

" }, "serverUrl":{ "shape":"Url", "documentation":"

The source URL used for plugin configuration.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" }, "type":{ "shape":"PluginType", "documentation":"

The type of plugin you want to create.

" } } }, "CreatePluginResponse":{ "type":"structure", "members":{ "pluginArn":{ "shape":"PluginArn", "documentation":"

The Amazon Resource Name (ARN) of a plugin.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin created.

" } } }, "CreateRetrieverRequest":{ "type":"structure", "required":[ "applicationId", "configuration", "displayName", "type" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of your Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify the request to create your Amazon Q application retriever.

", "idempotencyToken":true }, "configuration":{"shape":"RetrieverConfiguration"}, "displayName":{ "shape":"RetrieverName", "documentation":"

The name of your retriever.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" }, "type":{ "shape":"RetrieverType", "documentation":"

The type of retriever you are using.

" } } }, "CreateRetrieverResponse":{ "type":"structure", "members":{ "retrieverArn":{ "shape":"RetrieverArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of the retriever you are using.

" } } }, "CreateUserRequest":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application for which the user mapping will be created.

", "location":"uri", "locationName":"applicationId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify the request to create your Amazon Q user mapping.

", "idempotencyToken":true }, "userAliases":{ "shape":"CreateUserRequestUserAliasesList", "documentation":"

The list of user aliases in the mapping.

" }, "userId":{ "shape":"String", "documentation":"

The user emails attached to a user mapping.

" } } }, "CreateUserRequestUserAliasesList":{ "type":"list", "member":{"shape":"UserAlias"}, "max":100, "min":0 }, "CreateUserResponse":{ "type":"structure", "members":{ } }, "CreateWebExperienceRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q web experience.

", "location":"uri", "locationName":"applicationId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token you provide to identify a request to create an Amazon Q web experience.

", "idempotencyToken":true }, "samplePromptsControlMode":{ "shape":"WebExperienceSamplePromptsControlMode", "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" }, "subtitle":{ "shape":"WebExperienceSubtitle", "documentation":"

A subtitle to personalize your Amazon Q web experience.

" }, "tags":{ "shape":"Tags", "documentation":"

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: _ . : / = + - @.

" }, "title":{ "shape":"WebExperienceTitle", "documentation":"

The title for your Amazon Q web experience.

" }, "welcomeMessage":{ "shape":"WebExperienceWelcomeMessage", "documentation":"

The customized welcome message for end users of an Amazon Q web experience.

" } } }, "CreateWebExperienceResponse":{ "type":"structure", "members":{ "webExperienceArn":{ "shape":"WebExperienceArn", "documentation":"

The Amazon Resource Name (ARN) of an Amazon Q web experience.

" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of the Amazon Q web experience.

" } } }, "DataSource":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q data source was created.

" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the Amazon Q data source.

" }, "displayName":{ "shape":"DataSourceName", "documentation":"

The name of the Amazon Q data source.

" }, "status":{ "shape":"DataSourceStatus", "documentation":"

The status of the Amazon Q data source.

" }, "type":{ "shape":"String", "documentation":"

The type of the Amazon Q data source.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q data source was last updated.

" } }, "documentation":"

A data source in an Amazon Q application.

" }, "DataSourceArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "DataSourceConfiguration":{ "type":"structure", "members":{ }, "documentation":"

Provides the configuration information for an Amazon Q data source.

", "document":true }, "DataSourceId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "DataSourceIds":{ "type":"list", "member":{"shape":"DataSourceId"}, "max":1, "min":1 }, "DataSourceName":{ "type":"string", "max":1000, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" }, "DataSourceStatus":{ "type":"string", "enum":[ "PENDING_CREATION", "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING" ] }, "DataSourceSyncJob":{ "type":"structure", "members":{ "dataSourceErrorCode":{ "shape":"String", "documentation":"

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.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the synchronization job completed.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

If the `Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.

" }, "executionId":{ "shape":"ExecutionId", "documentation":"

The identifier of a data source synchronization job.

" }, "metrics":{ "shape":"DataSourceSyncJobMetrics", "documentation":"

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.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

The Unix time stamp when the data source synchronization job started.

" }, "status":{ "shape":"DataSourceSyncJobStatus", "documentation":"

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.

" } }, "documentation":"

Provides information about an Amazon Q data source connector synchronization job.

" }, "DataSourceSyncJobMetrics":{ "type":"structure", "members":{ "documentsAdded":{ "shape":"MetricValue", "documentation":"

The current count of documents added from the data source during the data source sync.

" }, "documentsDeleted":{ "shape":"MetricValue", "documentation":"

The current count of documents deleted from the data source during the data source sync.

" }, "documentsFailed":{ "shape":"MetricValue", "documentation":"

The current count of documents that failed to sync from the data source during the data source sync.

" }, "documentsModified":{ "shape":"MetricValue", "documentation":"

The current count of documents modified in the data source during the data source sync.

" }, "documentsScanned":{ "shape":"MetricValue", "documentation":"

The current count of documents crawled by the ongoing sync job in the data source.

" } }, "documentation":"

Maps a batch delete document request to a specific Amazon Q data source connector sync job.

" }, "DataSourceSyncJobStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING" ] }, "DataSourceSyncJobs":{ "type":"list", "member":{"shape":"DataSourceSyncJob"} }, "DataSourceUserId":{ "type":"string", "max":1024, "min":1, "pattern":"^\\P{C}*$" }, "DataSourceVpcConfiguration":{ "type":"structure", "required":[ "securityGroupIds", "subnetIds" ], "members":{ "securityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q to connect to the data source.

" }, "subnetIds":{ "shape":"SubnetIds", "documentation":"

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.

" } }, "documentation":"

Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).

" }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "DeleteApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" } } }, "DeleteApplicationResponse":{ "type":"structure", "members":{ } }, "DeleteChatControlsConfigurationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application the chat controls have been configured for.

", "location":"uri", "locationName":"applicationId" } } }, "DeleteChatControlsConfigurationResponse":{ "type":"structure", "members":{ } }, "DeleteConversationRequest":{ "type":"structure", "required":[ "applicationId", "conversationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application associated with the conversation.

", "location":"uri", "locationName":"applicationId" }, "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the Amazon Q web experience conversation being deleted.

", "location":"uri", "locationName":"conversationId" }, "userId":{ "shape":"UserId", "documentation":"

The identifier of the user who is deleting the conversation.

", "location":"querystring", "locationName":"userId" } } }, "DeleteConversationResponse":{ "type":"structure", "members":{ } }, "DeleteDataSourceRequest":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application used with the data source connector.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector that you want to delete.

", "location":"uri", "locationName":"dataSourceId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index used with the data source connector.

", "location":"uri", "locationName":"indexId" } } }, "DeleteDataSourceResponse":{ "type":"structure", "members":{ } }, "DeleteDocument":{ "type":"structure", "required":["documentId"], "members":{ "documentId":{ "shape":"DocumentId", "documentation":"

The identifier of the deleted document.

" } }, "documentation":"

A document deleted from an Amazon Q data source connector.

" }, "DeleteDocuments":{ "type":"list", "member":{"shape":"DeleteDocument"} }, "DeleteGroupRequest":{ "type":"structure", "required":[ "applicationId", "groupName", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application in which the group mapping belongs.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

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.

", "location":"querystring", "locationName":"dataSourceId" }, "groupName":{ "shape":"GroupName", "documentation":"

The name of the group you want to delete.

", "location":"uri", "locationName":"groupName" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index you want to delete the group from.

", "location":"uri", "locationName":"indexId" } } }, "DeleteGroupResponse":{ "type":"structure", "members":{ } }, "DeleteIndexRequest":{ "type":"structure", "required":[ "applicationId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application the Amazon Q index is linked to.

", "location":"uri", "locationName":"applicationId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index.

", "location":"uri", "locationName":"indexId" } } }, "DeleteIndexResponse":{ "type":"structure", "members":{ } }, "DeletePluginRequest":{ "type":"structure", "required":[ "applicationId", "pluginId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier the application attached to the Amazon Q plugin.

", "location":"uri", "locationName":"applicationId" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin being deleted.

", "location":"uri", "locationName":"pluginId" } } }, "DeletePluginResponse":{ "type":"structure", "members":{ } }, "DeleteRetrieverRequest":{ "type":"structure", "required":[ "applicationId", "retrieverId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the retriever.

", "location":"uri", "locationName":"applicationId" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of the retriever being deleted.

", "location":"uri", "locationName":"retrieverId" } } }, "DeleteRetrieverResponse":{ "type":"structure", "members":{ } }, "DeleteUserRequest":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application from which the user is being deleted.

", "location":"uri", "locationName":"applicationId" }, "userId":{ "shape":"String", "documentation":"

The user email being deleted.

", "location":"uri", "locationName":"userId" } } }, "DeleteUserResponse":{ "type":"structure", "members":{ } }, "DeleteWebExperienceRequest":{ "type":"structure", "required":[ "applicationId", "webExperienceId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the Amazon Q web experience.

", "location":"uri", "locationName":"applicationId" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of the Amazon Q web experience being deleted.

", "location":"uri", "locationName":"webExperienceId" } } }, "DeleteWebExperienceResponse":{ "type":"structure", "members":{ } }, "Description":{ "type":"string", "max":1000, "min":0, "pattern":"^\\P{C}*$" }, "Document":{ "type":"structure", "required":["id"], "members":{ "accessConfiguration":{ "shape":"AccessConfiguration", "documentation":"

Configuration information for access permission to a document.

" }, "attributes":{ "shape":"DocumentAttributes", "documentation":"

Custom attributes to apply to the document for refining Amazon Q web experience responses.

" }, "content":{ "shape":"DocumentContent", "documentation":"

The contents of the document.

" }, "contentType":{ "shape":"ContentType", "documentation":"

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.

" }, "documentEnrichmentConfiguration":{ "shape":"DocumentEnrichmentConfiguration", "documentation":"

The configuration information for altering document metadata and content during the document ingestion process.

" }, "id":{ "shape":"DocumentId", "documentation":"

The identifier of the document.

" }, "title":{ "shape":"Title", "documentation":"

The title of the document.

" } }, "documentation":"

A document in an Amazon Q application.

" }, "DocumentAttribute":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"DocumentAttributeKey", "documentation":"

The identifier for the attribute.

" }, "value":{ "shape":"DocumentAttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

A document attribute or metadata field.

" }, "DocumentAttributeCondition":{ "type":"structure", "required":[ "key", "operator" ], "members":{ "key":{ "shape":"DocumentAttributeKey", "documentation":"

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.

" }, "operator":{ "shape":"DocumentEnrichmentConditionOperator", "documentation":"

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.

" }, "value":{"shape":"DocumentAttributeValue"} }, "documentation":"

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.

" }, "DocumentAttributeConfiguration":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the document attribute.

" }, "search":{ "shape":"Status", "documentation":"

Information about whether the document attribute can be used by an end user to search for information on their web experience.

" }, "type":{ "shape":"AttributeType", "documentation":"

The type of document attribute.

" } }, "documentation":"

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.

" }, "DocumentAttributeConfigurations":{ "type":"list", "member":{"shape":"DocumentAttributeConfiguration"}, "max":500, "min":1 }, "DocumentAttributeKey":{ "type":"string", "max":200, "min":1, "pattern":"^[a-zA-Z0-9_][a-zA-Z0-9_-]*$" }, "DocumentAttributeStringListValue":{ "type":"list", "member":{"shape":"String"} }, "DocumentAttributeTarget":{ "type":"structure", "required":["key"], "members":{ "attributeValueOperator":{ "shape":"AttributeValueOperator", "documentation":"

`TRUE` to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to `TRUE`.

" }, "key":{ "shape":"DocumentAttributeKey", "documentation":"

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.

" }, "value":{"shape":"DocumentAttributeValue"} }, "documentation":"

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` .

" }, "DocumentAttributeValue":{ "type":"structure", "members":{ "dateValue":{ "shape":"Timestamp", "documentation":"

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.

" }, "longValue":{ "shape":"Long", "documentation":"

A long integer value.

" }, "stringListValue":{ "shape":"DocumentAttributeStringListValue", "documentation":"

A list of strings.

" }, "stringValue":{ "shape":"DocumentAttributeValueStringValueString", "documentation":"

A string.

" } }, "documentation":"

The value of a document attribute. You can only provide one value for a document attribute.

", "union":true }, "DocumentAttributeValueStringValueString":{ "type":"string", "max":2048, "min":0 }, "DocumentAttributes":{ "type":"list", "member":{"shape":"DocumentAttribute"}, "max":500, "min":1 }, "DocumentContent":{ "type":"structure", "members":{ "blob":{ "shape":"Blob", "documentation":"

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.

" }, "s3":{ "shape":"S3", "documentation":"

The path to the document in an Amazon S3 bucket.

" } }, "documentation":"

The contents of a document.

", "union":true }, "DocumentContentOperator":{ "type":"string", "enum":["DELETE"] }, "DocumentDetailList":{ "type":"list", "member":{"shape":"DocumentDetails"} }, "DocumentDetails":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the document was created.

" }, "documentId":{ "shape":"DocumentId", "documentation":"

The identifier of the document.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

An error message associated with the document.

" }, "status":{ "shape":"DocumentStatus", "documentation":"

The current status of the document.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the document was last updated.

" } }, "documentation":"

The details of a document within an Amazon Q index.

" }, "DocumentEnrichmentConditionOperator":{ "type":"string", "enum":[ "GREATER_THAN", "GREATER_THAN_OR_EQUALS", "LESS_THAN", "LESS_THAN_OR_EQUALS", "EQUALS", "NOT_EQUALS", "CONTAINS", "NOT_CONTAINS", "EXISTS", "NOT_EXISTS", "BEGINS_WITH" ] }, "DocumentEnrichmentConfiguration":{ "type":"structure", "members":{ "inlineConfigurations":{ "shape":"InlineDocumentEnrichmentConfigurations", "documentation":"

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.

" }, "postExtractionHookConfiguration":{"shape":"HookConfiguration"}, "preExtractionHookConfiguration":{"shape":"HookConfiguration"} }, "documentation":"

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Custom document enrichment.

" }, "DocumentId":{ "type":"string", "max":1825, "min":1, "pattern":"^\\P{C}*$" }, "DocumentStatus":{ "type":"string", "enum":[ "RECEIVED", "PROCESSING", "INDEXED", "UPDATED", "FAILED", "DELETING", "DELETED", "DOCUMENT_FAILED_TO_INDEX" ] }, "Documents":{ "type":"list", "member":{"shape":"Document"}, "max":10, "min":1 }, "EligibleDataSource":{ "type":"structure", "members":{ "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index the data source is attached to.

" } }, "documentation":"

The identifier of the data source Amazon Q will generate responses from.

" }, "EligibleDataSources":{ "type":"list", "member":{"shape":"EligibleDataSource"}, "max":5, "min":0 }, "EncryptionConfiguration":{ "type":"structure", "members":{ "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

The identifier of the KMS key. Amazon Q doesn't support asymmetric keys.

" } }, "documentation":"

Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.

" }, "ErrorCode":{ "type":"string", "enum":[ "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound" ] }, "ErrorDetail":{ "type":"structure", "members":{ "errorCode":{ "shape":"ErrorCode", "documentation":"

The code associated with the data source sync error.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

The message explaining the data source sync error.

" } }, "documentation":"

Provides information about a data source sync error.

" }, "ErrorMessage":{ "type":"string", "max":2048, "min":1, "pattern":"^\\P{C}*$" }, "ExampleChatMessage":{ "type":"string", "max":350, "min":0, "pattern":"^\\P{C}*$" }, "ExampleChatMessages":{ "type":"list", "member":{"shape":"ExampleChatMessage"}, "max":5, "min":0 }, "ExecutionId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "FailedDocument":{ "type":"structure", "members":{ "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the Amazon Q data source connector that contains the failed document.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

An explanation for why the document couldn't be removed from the index.

" }, "id":{ "shape":"DocumentId", "documentation":"

The identifier of the document that couldn't be removed from the Amazon Q index.

" } }, "documentation":"

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.

" }, "FailedDocuments":{ "type":"list", "member":{"shape":"FailedDocument"} }, "GetApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" } } }, "GetApplicationResponse":{ "type":"structure", "members":{ "applicationArn":{ "shape":"ApplicationArn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application.

" }, "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

" }, "attachmentsConfiguration":{ "shape":"AppliedAttachmentsConfiguration", "documentation":"

Settings for whether end users can upload files directly during chat.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" }, "description":{ "shape":"Description", "documentation":"

A description for the Amazon Q application.

" }, "displayName":{ "shape":"ApplicationName", "documentation":"

The name of the Amazon Q application.

" }, "encryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

If the `Status` field is set to `ERROR`, the `ErrorMessage` field contains a description of the error that caused the synchronization to fail.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

" }, "status":{ "shape":"ApplicationStatus", "documentation":"

The status of the Amazon Q application.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" } } }, "GetChatControlsConfigurationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application for which the chat controls are configured.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForGetTopicConfigurations", "documentation":"

The maximum number of configured chat controls to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "GetChatControlsConfigurationResponse":{ "type":"structure", "members":{ "blockedPhrases":{ "shape":"BlockedPhrasesConfiguration", "documentation":"

The phrases blocked from chat by your chat control configuration.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "responseScope":{ "shape":"ResponseScope", "documentation":"

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.

" }, "topicConfigurations":{ "shape":"TopicConfigurations", "documentation":"

The topic specific controls configured for a Amazon Q application.

" } } }, "GetDataSourceRequest":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

", "location":"uri", "locationName":"dataSourceId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identfier of the index used with the data source connector.

", "location":"uri", "locationName":"indexId" } } }, "GetDataSourceResponse":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

" }, "configuration":{ "shape":"DataSourceConfiguration", "documentation":"

The details of how the data source connector is configured.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the data source connector was created.

" }, "dataSourceArn":{ "shape":"DataSourceArn", "documentation":"

The Amazon Resource Name (ARN) of the data source.

" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

" }, "description":{ "shape":"Description", "documentation":"

The description for the data source connector.

" }, "displayName":{ "shape":"DataSourceName", "documentation":"

The name for the data source connector.

" }, "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, "error":{ "shape":"ErrorDetail", "documentation":"

When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index linked to the data source connector.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

" }, "status":{ "shape":"DataSourceStatus", "documentation":"

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.

" }, "syncSchedule":{ "shape":"SyncSchedule", "documentation":"

The schedule for Amazon Q to update the index.

" }, "type":{ "shape":"String", "documentation":"

The type of the data source connector. For example, `S3`.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the data source connector was last updated.

" }, "vpcConfiguration":{ "shape":"DataSourceVpcConfiguration", "documentation":"

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

" } } }, "GetGroupRequest":{ "type":"structure", "required":[ "applicationId", "groupName", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application id the group is attached to.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source the group is attached to.

", "location":"querystring", "locationName":"dataSourceId" }, "groupName":{ "shape":"GroupName", "documentation":"

The name of the group.

", "location":"uri", "locationName":"groupName" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index the group is attached to.

", "location":"uri", "locationName":"indexId" } } }, "GetGroupResponse":{ "type":"structure", "members":{ "status":{ "shape":"GroupStatusDetail", "documentation":"

The current status of the group.

" }, "statusHistory":{ "shape":"GroupStatusDetails", "documentation":"

The status history of the group.

" } } }, "GetIndexRequest":{ "type":"structure", "required":[ "applicationId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application connected to the index.

", "location":"uri", "locationName":"applicationId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index you want information on.

", "location":"uri", "locationName":"indexId" } } }, "GetIndexResponse":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application associated with the index.

" }, "capacityConfiguration":{ "shape":"IndexCapacityConfiguration", "documentation":"

The storage capacity units chosen for your Amazon Q index.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q index was created.

" }, "description":{ "shape":"Description", "documentation":"

The description for the Amazon Q index.

" }, "displayName":{ "shape":"IndexName", "documentation":"

The name of the Amazon Q index.

" }, "documentAttributeConfigurations":{ "shape":"DocumentAttributeConfigurations", "documentation":"

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.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.

" }, "indexArn":{ "shape":"IndexArn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q index.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index.

" }, "indexStatistics":{ "shape":"IndexStatistics", "documentation":"

Provides information about the number of documents indexed.

" }, "status":{ "shape":"IndexStatus", "documentation":"

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.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q index was last updated.

" } } }, "GetPluginRequest":{ "type":"structure", "required":[ "applicationId", "pluginId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application which contains the plugin.

", "location":"uri", "locationName":"applicationId" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin.

", "location":"uri", "locationName":"pluginId" } } }, "GetPluginResponse":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application which contains the plugin.

" }, "authConfiguration":{"shape":"PluginAuthConfiguration"}, "createdAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the plugin was created.

" }, "displayName":{ "shape":"PluginName", "documentation":"

The name of the plugin.

" }, "pluginArn":{ "shape":"PluginArn", "documentation":"

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin.

" }, "serverUrl":{ "shape":"Url", "documentation":"

The source URL used for plugin configuration.

" }, "state":{ "shape":"PluginState", "documentation":"

The current state of the plugin.

" }, "type":{ "shape":"PluginType", "documentation":"

The type of the plugin.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the plugin was last updated.

" } } }, "GetRetrieverRequest":{ "type":"structure", "required":[ "applicationId", "retrieverId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the retriever.

", "location":"uri", "locationName":"applicationId" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of the retriever.

", "location":"uri", "locationName":"retrieverId" } } }, "GetRetrieverResponse":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the retriever.

" }, "configuration":{"shape":"RetrieverConfiguration"}, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the retriever was created.

" }, "displayName":{ "shape":"RetrieverName", "documentation":"

The name of the retriever.

" }, "retrieverArn":{ "shape":"RetrieverArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of the retriever.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

" }, "status":{ "shape":"RetrieverStatus", "documentation":"

The status of the retriever.

" }, "type":{ "shape":"RetrieverType", "documentation":"

The type of the retriever.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the retriever was last updated.

" } } }, "GetUserRequest":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application connected to the user.

", "location":"uri", "locationName":"applicationId" }, "userId":{ "shape":"String", "documentation":"

The user email address attached to the user.

", "location":"uri", "locationName":"userId" } } }, "GetUserResponse":{ "type":"structure", "members":{ "userAliases":{ "shape":"UserAliases", "documentation":"

A list of user aliases attached to a user.

" } } }, "GetWebExperienceRequest":{ "type":"structure", "required":[ "applicationId", "webExperienceId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the web experience.

", "location":"uri", "locationName":"applicationId" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of the Amazon Q web experience.

", "location":"uri", "locationName":"webExperienceId" } } }, "GetWebExperienceResponse":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the web experience.

" }, "authenticationConfiguration":{ "shape":"WebExperienceAuthConfiguration", "documentation":"

The authentication configuration information for your Amazon Q web experience.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the retriever was created.

" }, "defaultEndpoint":{ "shape":"Url", "documentation":"

The endpoint of your Amazon Q web experience.

" }, "error":{ "shape":"ErrorDetail", "documentation":"

When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source connector to fail.

" }, "samplePromptsControlMode":{ "shape":"WebExperienceSamplePromptsControlMode", "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" }, "status":{ "shape":"WebExperienceStatus", "documentation":"

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.

" }, "subtitle":{ "shape":"WebExperienceSubtitle", "documentation":"

The subtitle for your Amazon Q web experience.

" }, "title":{ "shape":"WebExperienceTitle", "documentation":"

The title for your Amazon Q web experience.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the data source connector was last updated.

" }, "webExperienceArn":{ "shape":"WebExperienceArn", "documentation":"

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.

" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of the Amazon Q web experience.

" }, "welcomeMessage":{ "shape":"WebExperienceWelcomeMessage", "documentation":"

The customized welcome message for end users of an Amazon Q web experience.

" } } }, "GroupMembers":{ "type":"structure", "members":{ "memberGroups":{ "shape":"MemberGroups", "documentation":"

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\".

" }, "memberUsers":{ "shape":"MemberUsers", "documentation":"

A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.

" } }, "documentation":"

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.

" }, "GroupName":{ "type":"string", "max":1024, "min":1, "pattern":"^\\P{C}*$" }, "GroupStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED" ] }, "GroupStatusDetail":{ "type":"structure", "members":{ "errorDetail":{ "shape":"ErrorDetail", "documentation":"

The details of an error associated a group status.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" }, "status":{ "shape":"GroupStatus", "documentation":"

The status of a group.

" } }, "documentation":"

Provides the details of a group's status.

" }, "GroupStatusDetails":{ "type":"list", "member":{"shape":"GroupStatusDetail"} }, "GroupSummary":{ "type":"structure", "members":{ "groupName":{ "shape":"GroupName", "documentation":"

The name of the group the summary information is for.

" } }, "documentation":"

Summary information for groups.

" }, "GroupSummaryList":{ "type":"list", "member":{"shape":"GroupSummary"} }, "HookConfiguration":{ "type":"structure", "members":{ "invocationCondition":{ "shape":"DocumentAttributeCondition", "documentation":"

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.

" }, "lambdaArn":{ "shape":"LambdaArn", "documentation":"

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).

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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.

" }, "s3BucketName":{ "shape":"S3BucketName", "documentation":"

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

" } }, "documentation":"

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.

" }, "Index":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the index was created.

" }, "displayName":{ "shape":"IndexName", "documentation":"

The name of the index.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier for the index.

" }, "status":{ "shape":"IndexStatus", "documentation":"

The current status of the index. When the status is `ACTIVE`, the index is ready.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the index was last updated.

" } }, "documentation":"

Summary information for your Amazon Q index.

" }, "IndexArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "IndexCapacityConfiguration":{ "type":"structure", "members":{ "units":{ "shape":"IndexCapacityInteger", "documentation":"

The number of storage units configured for an Amazon Q index.

" } }, "documentation":"

Provides information about index capacity configuration.

" }, "IndexCapacityInteger":{ "type":"integer", "box":true, "min":1 }, "IndexId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "IndexName":{ "type":"string", "max":1000, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" }, "IndexStatistics":{ "type":"structure", "members":{ "textDocumentStatistics":{ "shape":"TextDocumentStatistics", "documentation":"

The number of documents indexed.

" } }, "documentation":"

Provides information about the number of documents in an index.

" }, "IndexStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING" ] }, "IndexedTextBytes":{ "type":"long", "box":true, "min":0 }, "IndexedTextDocument":{ "type":"integer", "box":true, "min":0 }, "Indices":{ "type":"list", "member":{"shape":"Index"} }, "InlineDocumentEnrichmentConfiguration":{ "type":"structure", "members":{ "condition":{"shape":"DocumentAttributeCondition"}, "documentContentOperator":{ "shape":"DocumentContentOperator", "documentation":"

`TRUE` to delete content if the condition used for the target attribute is met.

" }, "target":{"shape":"DocumentAttributeTarget"} }, "documentation":"

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.

" }, "InlineDocumentEnrichmentConfigurations":{ "type":"list", "member":{"shape":"InlineDocumentEnrichmentConfiguration"}, "max":100, "min":1 }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

An issue occurred with the internal server used for your Amazon Q service. Wait some minutes and try again, or contact Support for help.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KendraIndexConfiguration":{ "type":"structure", "required":["indexId"], "members":{ "indexId":{ "shape":"KendraIndexId", "documentation":"

The identifier of the Amazon Kendra index.

" } }, "documentation":"

Stores an Amazon Kendra index as a retriever.

" }, "KendraIndexId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "KmsKeyId":{ "type":"string", "max":2048, "min":1, "sensitive":true }, "LambdaArn":{ "type":"string", "max":2048, "min":1, "pattern":"^arn:aws[a-zA-Z-]*:lambda:[a-z-]*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$" }, "LicenseNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

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.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ListApplicationsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResultsIntegerForListApplications", "documentation":"

The maximum number of Amazon Q applications to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListApplicationsResponse":{ "type":"structure", "members":{ "applications":{ "shape":"Applications", "documentation":"

An array of summary information on the configuration of one or more Amazon Q applications.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListConversations", "documentation":"

The maximum number of Amazon Q conversations to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "userId":{ "shape":"UserId", "documentation":"

The identifier of the user involved in the Amazon Q web experience conversation.

", "location":"querystring", "locationName":"userId" } } }, "ListConversationsResponse":{ "type":"structure", "members":{ "conversations":{ "shape":"Conversations", "documentation":"

An array of summary information on the configuration of one or more Amazon Q web experiences.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application connected to the data source.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

", "location":"uri", "locationName":"dataSourceId" }, "endTime":{ "shape":"Timestamp", "documentation":"

The end time of the data source connector sync.

", "location":"querystring", "locationName":"endTime" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index used with the Amazon Q data source connector.

", "location":"uri", "locationName":"indexId" }, "maxResults":{ "shape":"MaxResultsIntegerForListDataSourcesSyncJobs", "documentation":"

The maximum number of synchronization jobs to return in the response.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "startTime":{ "shape":"Timestamp", "documentation":"

The start time of the data source connector sync.

", "location":"querystring", "locationName":"startTime" }, "statusFilter":{ "shape":"DataSourceSyncJobStatus", "documentation":"

Only returns synchronization jobs with the `Status` field equal to the specified status.

", "location":"querystring", "locationName":"syncStatus" } } }, "ListDataSourceSyncJobsResponse":{ "type":"structure", "members":{ "history":{ "shape":"DataSourceSyncJobs", "documentation":"

A history of synchronization jobs for the data source connector.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":[ "applicationId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the data source connectors.

", "location":"uri", "locationName":"applicationId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index used with one or more data source connectors.

", "location":"uri", "locationName":"indexId" }, "maxResults":{ "shape":"MaxResultsIntegerForListDataSources", "documentation":"

The maximum number of data source connectors to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListDataSourcesResponse":{ "type":"structure", "members":{ "dataSources":{ "shape":"DataSources", "documentation":"

An array of summary information for one or more data source connector.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":[ "applicationId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application id the documents are attached to.

", "location":"uri", "locationName":"applicationId" }, "dataSourceIds":{ "shape":"DataSourceIds", "documentation":"

The identifier of the data sources the documents are attached to.

", "location":"querystring", "locationName":"dataSourceIds" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index the documents are attached to.

", "location":"uri", "locationName":"indexId" }, "maxResults":{ "shape":"MaxResultsIntegerForListDocuments", "documentation":"

The maximum number of documents to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListDocumentsResponse":{ "type":"structure", "members":{ "documentDetailList":{ "shape":"DocumentDetailList", "documentation":"

A list of document details.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "ListGroupsRequest":{ "type":"structure", "required":[ "applicationId", "indexId", "updatedEarlierThan" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application for getting a list of groups mapped to users.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source for getting a list of groups mapped to users.

", "location":"querystring", "locationName":"dataSourceId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index for getting a list of groups mapped to users.

", "location":"uri", "locationName":"indexId" }, "maxResults":{ "shape":"MaxResultsIntegerForListGroupsRequest", "documentation":"

The maximum number of returned groups that are mapped to users.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "updatedEarlierThan":{ "shape":"Timestamp", "documentation":"

The timestamp identifier used for the latest `PUT` or `DELETE` action for mapping users to their groups.

", "location":"querystring", "locationName":"updatedEarlierThan" } } }, "ListGroupsResponse":{ "type":"structure", "members":{ "items":{ "shape":"GroupSummaryList", "documentation":"

Summary information for list of groups that are mapped to users.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application connected to the index.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListIndices", "documentation":"

The maximum number of indices to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListIndicesResponse":{ "type":"structure", "members":{ "indices":{ "shape":"Indices", "documentation":"

An array of information on the items in one or more indexes.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":[ "applicationId", "conversationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier for the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the Amazon Q web experience conversation.

", "location":"uri", "locationName":"conversationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListMessages", "documentation":"

The maximum number of messages to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "userId":{ "shape":"UserId", "documentation":"

The identifier of the user involved in the Amazon Q web experience conversation.

", "location":"querystring", "locationName":"userId" } } }, "ListMessagesResponse":{ "type":"structure", "members":{ "messages":{ "shape":"Messages", "documentation":"

An array of information on one or more messages.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application the plugin is attached to.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListPlugins", "documentation":"

The maximum number of documents to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListPluginsResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "plugins":{ "shape":"Plugins", "documentation":"

Information about a configured plugin.

" } } }, "ListRetrieversRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the retriever.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListRetrieversRequest", "documentation":"

The maximum number of retrievers returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListRetrieversResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "retrievers":{ "shape":"Retrievers", "documentation":"

An array of summary information for one or more retrievers.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceARN"], "members":{ "resourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.

", "location":"uri", "locationName":"resourceARN" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

A list of tags associated with the Amazon Q application or data source.

" } } }, "ListWebExperiencesRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application linked to the listed web experiences.

", "location":"uri", "locationName":"applicationId" }, "maxResults":{ "shape":"MaxResultsIntegerForListWebExperiencesRequest", "documentation":"

The maximum number of Amazon Q Web Experiences to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" } } }, "ListWebExperiencesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "webExperiences":{ "shape":"WebExperiences", "documentation":"

An array of summary information for one or more Amazon Q experiences.

" } } }, "Long":{ "type":"long", "box":true }, "MaxResultsIntegerForGetTopicConfigurations":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxResultsIntegerForListApplications":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsIntegerForListConversations":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsIntegerForListDataSources":{ "type":"integer", "box":true, "max":10, "min":1 }, "MaxResultsIntegerForListDataSourcesSyncJobs":{ "type":"integer", "box":true, "max":10, "min":1 }, "MaxResultsIntegerForListDocuments":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsIntegerForListGroupsRequest":{ "type":"integer", "box":true, "max":10, "min":1 }, "MaxResultsIntegerForListIndices":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsIntegerForListMessages":{ "type":"integer", "box":true, "max":100, "min":1 }, "MaxResultsIntegerForListPlugins":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxResultsIntegerForListRetrieversRequest":{ "type":"integer", "box":true, "max":50, "min":1 }, "MaxResultsIntegerForListWebExperiencesRequest":{ "type":"integer", "box":true, "max":100, "min":1 }, "MemberGroup":{ "type":"structure", "required":["groupName"], "members":{ "groupName":{ "shape":"GroupName", "documentation":"

The name of the sub group.

" }, "type":{ "shape":"MembershipType", "documentation":"

The type of the sub group.

" } }, "documentation":"

The sub groups that belong to a group.

" }, "MemberGroups":{ "type":"list", "member":{"shape":"MemberGroup"}, "max":1000, "min":1 }, "MemberRelation":{ "type":"string", "enum":[ "AND", "OR" ] }, "MemberUser":{ "type":"structure", "required":["userId"], "members":{ "type":{ "shape":"MembershipType", "documentation":"

The type of the user.

" }, "userId":{ "shape":"DataSourceUserId", "documentation":"

The identifier of the user you want to map to a group.

" } }, "documentation":"

The users that belong to a group.

" }, "MemberUsers":{ "type":"list", "member":{"shape":"MemberUser"}, "max":1000, "min":1 }, "MembershipType":{ "type":"string", "enum":[ "INDEX", "DATASOURCE" ] }, "Message":{ "type":"structure", "members":{ "actionExecution":{"shape":"ActionExecution"}, "actionReview":{"shape":"ActionReview"}, "attachments":{ "shape":"AttachmentsOutput", "documentation":"

A file directly uploaded into an Amazon Q web experience chat.

" }, "body":{ "shape":"MessageBody", "documentation":"

The content of the Amazon Q web experience message.

" }, "messageId":{ "shape":"String", "documentation":"

The identifier of the Amazon Q web experience message.

" }, "sourceAttribution":{ "shape":"SourceAttributions", "documentation":"

The source documents used to generate Amazon Q web experience message.

" }, "time":{ "shape":"Timestamp", "documentation":"

The timestamp of the first Amazon Q web experience message.

" }, "type":{ "shape":"MessageType", "documentation":"

The type of Amazon Q message, whether `HUMAN` or `AI` generated.

" } }, "documentation":"

A message in an Amazon Q web experience.

" }, "MessageBody":{ "type":"string", "max":1000, "min":0, "pattern":"^\\P{C}*$}$" }, "MessageId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "MessageType":{ "type":"string", "enum":[ "USER", "SYSTEM" ] }, "MessageUsefulness":{ "type":"string", "enum":[ "USEFUL", "NOT_USEFUL" ] }, "MessageUsefulnessComment":{ "type":"string", "max":1000, "min":0, "pattern":"^\\P{C}*$" }, "MessageUsefulnessFeedback":{ "type":"structure", "required":[ "submittedAt", "usefulness" ], "members":{ "comment":{ "shape":"MessageUsefulnessComment", "documentation":"

A comment given by an end user on the usefulness of an AI-generated chat message.

" }, "reason":{ "shape":"MessageUsefulnessReason", "documentation":"

The reason for a usefulness rating.

" }, "submittedAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the feedback was submitted.

" }, "usefulness":{ "shape":"MessageUsefulness", "documentation":"

The usefulness value assigned by an end user to a message.

" } }, "documentation":"

End user feedback on an AI-generated web experience chat message usefulness.

" }, "MessageUsefulnessReason":{ "type":"string", "enum":[ "NOT_FACTUALLY_CORRECT", "HARMFUL_OR_UNSAFE", "INCORRECT_OR_MISSING_SOURCES", "NOT_HELPFUL", "FACTUALLY_CORRECT", "COMPLETE", "RELEVANT_SOURCES", "HELPFUL" ] }, "Messages":{ "type":"list", "member":{"shape":"Message"} }, "MetricValue":{ "type":"string", "pattern":"^(([1-9][0-9]*)|0)$" }, "NativeIndexConfiguration":{ "type":"structure", "required":["indexId"], "members":{ "indexId":{ "shape":"IndexId", "documentation":"

The identifier for the Amazon Q index.

" } }, "documentation":"

Configuration information for an Amazon Q index.

" }, "NextToken":{ "type":"string", "max":800, "min":1 }, "OAuth2ClientCredentialConfiguration":{ "type":"structure", "required":[ "roleArn", "secretArn" ], "members":{ "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

" }, "secretArn":{ "shape":"SecretArn", "documentation":"

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

" } }, "documentation":"

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" }, "Plugin":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the plugin was created.

" }, "displayName":{ "shape":"PluginName", "documentation":"

The name of the plugin.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin.

" }, "serverUrl":{ "shape":"Url", "documentation":"

The plugin server URL used for configuration.

" }, "state":{ "shape":"PluginState", "documentation":"

The current status of the plugin.

" }, "type":{ "shape":"PluginType", "documentation":"

The type of the plugin.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the plugin was last updated.

" } }, "documentation":"

Information about an Amazon Q plugin and its configuration.

" }, "PluginArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "PluginAuthConfiguration":{ "type":"structure", "members":{ "basicAuthConfiguration":{ "shape":"BasicAuthConfiguration", "documentation":"

Information about the basic authentication credentials used to configure a plugin.

" }, "oAuth2ClientCredentialConfiguration":{ "shape":"OAuth2ClientCredentialConfiguration", "documentation":"

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

" } }, "documentation":"

Authentication configuration information for an Amazon Q plugin.

", "union":true }, "PluginId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "PluginName":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" }, "PluginState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "PluginType":{ "type":"string", "enum":[ "SERVICE_NOW", "SALESFORCE", "JIRA", "ZENDESK" ] }, "Plugins":{ "type":"list", "member":{"shape":"Plugin"} }, "Principal":{ "type":"structure", "members":{ "group":{ "shape":"PrincipalGroup", "documentation":"

The group associated with the principal.

" }, "user":{ "shape":"PrincipalUser", "documentation":"

The user associated with the principal.

" } }, "documentation":"

Provides user and group information used for filtering documents to use for generating Amazon Q conversation responses.

", "union":true }, "PrincipalGroup":{ "type":"structure", "required":["access"], "members":{ "access":{ "shape":"ReadAccessType", "documentation":"

Provides information about whether to allow or deny access to the principal.

" }, "membershipType":{ "shape":"MembershipType", "documentation":"

The type of group.

" }, "name":{ "shape":"GroupName", "documentation":"

The name of the group.

" } }, "documentation":"

Provides information about a group associated with the principal.

" }, "PrincipalUser":{ "type":"structure", "required":["access"], "members":{ "access":{ "shape":"ReadAccessType", "documentation":"

Provides information about whether to allow or deny access to the principal.

" }, "id":{ "shape":"UserId", "documentation":"

The identifier of the user.

" }, "membershipType":{ "shape":"MembershipType", "documentation":"

The type of group.

" } }, "documentation":"

Provides information about a user associated with a principal.

" }, "Principals":{ "type":"list", "member":{"shape":"Principal"} }, "PutFeedbackRequest":{ "type":"structure", "required":[ "applicationId", "conversationId", "messageId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application associated with the feedback.

", "location":"uri", "locationName":"applicationId" }, "conversationId":{ "shape":"ConversationId", "documentation":"

The identifier of the conversation the feedback is attached to.

", "location":"uri", "locationName":"conversationId" }, "messageCopiedAt":{ "shape":"Timestamp", "documentation":"

The timestamp for when the feedback was recorded.

" }, "messageId":{ "shape":"SystemMessageId", "documentation":"

The identifier of the chat message that the feedback was given for.

", "location":"uri", "locationName":"messageId" }, "messageUsefulness":{ "shape":"MessageUsefulnessFeedback", "documentation":"

The feedback usefulness value given by the user to the chat message.

" }, "userId":{ "shape":"UserId", "documentation":"

The identifier of the user giving the feedback.

", "location":"querystring", "locationName":"userId" } } }, "PutGroupRequest":{ "type":"structure", "required":[ "applicationId", "groupMembers", "groupName", "indexId", "type" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application in which the user and group mapping belongs.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

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.

" }, "groupMembers":{"shape":"GroupMembers"}, "groupName":{ "shape":"GroupName", "documentation":"

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.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index in which you want to map users to their groups.

", "location":"uri", "locationName":"indexId" }, "type":{ "shape":"MembershipType", "documentation":"

The type of the group.

" } } }, "PutGroupResponse":{ "type":"structure", "members":{ } }, "ReadAccessType":{ "type":"string", "enum":[ "ALLOW", "DENY" ] }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message describing a `ResourceNotFoundException`.

" }, "resourceId":{ "shape":"String", "documentation":"

The identifier of the resource affected.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of the resource affected.

" } }, "documentation":"

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResponseScope":{ "type":"string", "enum":[ "ENTERPRISE_CONTENT_ONLY", "EXTENDED_KNOWLEDGE_ENABLED" ] }, "Retriever":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application using the retriever.

" }, "displayName":{ "shape":"RetrieverName", "documentation":"

The name of your retriever.

" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of the retriever used by your Amazon Q application.

" }, "status":{ "shape":"RetrieverStatus", "documentation":"

The status of your retriever.

" }, "type":{ "shape":"RetrieverType", "documentation":"

The type of your retriever.

" } }, "documentation":"

Summary information for the retriever used for your Amazon Q application.

" }, "RetrieverArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "RetrieverConfiguration":{ "type":"structure", "members":{ "kendraIndexConfiguration":{ "shape":"KendraIndexConfiguration", "documentation":"

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.

" }, "nativeIndexConfiguration":{ "shape":"NativeIndexConfiguration", "documentation":"

Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.

" } }, "documentation":"

Provides information on how the retriever used for your Amazon Q application is configured.

", "union":true }, "RetrieverId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "RetrieverName":{ "type":"string", "max":1000, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" }, "RetrieverStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "FAILED" ] }, "RetrieverType":{ "type":"string", "enum":[ "NATIVE_INDEX", "KENDRA_INDEX" ] }, "Retrievers":{ "type":"list", "member":{"shape":"Retriever"} }, "RoleArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "Rule":{ "type":"structure", "required":["ruleType"], "members":{ "excludedUsersAndGroups":{ "shape":"UsersAndGroups", "documentation":"

Users and groups to be excluded from a rule.

" }, "includedUsersAndGroups":{ "shape":"UsersAndGroups", "documentation":"

Users and groups to be included in a rule.

" }, "ruleConfiguration":{ "shape":"RuleConfiguration", "documentation":"

The configuration information for a rule.

" }, "ruleType":{ "shape":"RuleType", "documentation":"

The type fo rule.

" } }, "documentation":"

Guardrail rules for an Amazon Q application. Amazon Q supports only one rule at a time.

" }, "RuleConfiguration":{ "type":"structure", "members":{ "contentBlockerRule":{ "shape":"ContentBlockerRule", "documentation":"

A rule for configuring how Amazon Q responds when it encounters a a blocked topic.

" }, "contentRetrievalRule":{"shape":"ContentRetrievalRule"} }, "documentation":"

Provides configuration information about a rule.

", "union":true }, "RuleType":{ "type":"string", "enum":[ "CONTENT_BLOCKER_RULE", "CONTENT_RETRIEVAL_RULE" ] }, "Rules":{ "type":"list", "member":{"shape":"Rule"}, "max":10, "min":0 }, "S3":{ "type":"structure", "required":[ "bucket", "key" ], "members":{ "bucket":{ "shape":"S3BucketName", "documentation":"

The name of the S3 bucket that contains the file.

" }, "key":{ "shape":"S3ObjectKey", "documentation":"

The name of the file.

" } }, "documentation":"

Information required for Amazon Q to find a specific file in an Amazon S3 bucket.

" }, "S3BucketName":{ "type":"string", "max":63, "min":1, "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" }, "S3ObjectKey":{ "type":"string", "max":1024, "min":1 }, "SamlAttribute":{ "type":"string", "max":256, "min":1 }, "SamlConfiguration":{ "type":"structure", "required":[ "metadataXML", "roleArn", "userIdAttribute" ], "members":{ "metadataXML":{ "shape":"SamlMetadataXML", "documentation":"

The metadata XML that your IdP generated.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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.

" }, "userGroupAttribute":{ "shape":"SamlAttribute", "documentation":"

The group attribute name in your IdP that maps to user groups.

" }, "userIdAttribute":{ "shape":"SamlAttribute", "documentation":"

The user attribute name in your IdP that maps to the user email.

" } }, "documentation":"

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.

" }, "SamlMetadataXML":{ "type":"string", "max":10000000, "min":1000, "pattern":"^.*$" }, "SecretArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "SecurityGroupId":{ "type":"string", "max":200, "min":1, "pattern":"^[-0-9a-zA-Z]+$" }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"SecurityGroupId"}, "max":10, "min":1 }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message describing a `ServiceQuotaExceededException`.

" }, "resourceId":{ "shape":"String", "documentation":"

The identifier of the resource affected.

" }, "resourceType":{ "shape":"String", "documentation":"

The type of the resource affected.

" } }, "documentation":"

You have exceeded the set limits for your Amazon Q service.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SourceAttribution":{ "type":"structure", "members":{ "citationNumber":{ "shape":"Integer", "documentation":"

The number attached to a citation in an Amazon Q generated response.

" }, "snippet":{ "shape":"String", "documentation":"

The content extract from the document on which the generated response is based.

" }, "textMessageSegments":{ "shape":"TextSegmentList", "documentation":"

A text extract from a source document that is used for source attribution.

" }, "title":{ "shape":"String", "documentation":"

The title of the document which is the source for the Amazon Q generated response.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" }, "url":{ "shape":"String", "documentation":"

The URL of the document which is the source for the Amazon Q generated response.

" } }, "documentation":"

The documents used to generate an Amazon Q web experience response.

" }, "SourceAttributions":{ "type":"list", "member":{"shape":"SourceAttribution"} }, "StartDataSourceSyncJobRequest":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of Amazon Q application the data source is connected to.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

", "location":"uri", "locationName":"dataSourceId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index used with the data source connector.

", "location":"uri", "locationName":"indexId" } } }, "StartDataSourceSyncJobResponse":{ "type":"structure", "members":{ "executionId":{ "shape":"ExecutionId", "documentation":"

The identifier for a particular synchronization job.

" } } }, "Status":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "StopDataSourceSyncJobRequest":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application that the data source is connected to.

", "location":"uri", "locationName":"applicationId" }, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

", "location":"uri", "locationName":"dataSourceId" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index used with the Amazon Q data source connector.

", "location":"uri", "locationName":"indexId" } } }, "StopDataSourceSyncJobResponse":{ "type":"structure", "members":{ } }, "String":{ "type":"string", "max":2048, "min":1 }, "SubnetId":{ "type":"string", "max":200, "min":1, "pattern":"^[-0-9a-zA-Z]+$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"} }, "SyncSchedule":{ "type":"string", "max":998, "min":0, "pattern":"^\\P{C}*$" }, "SystemMessageId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" }, "SystemMessageOverride":{ "type":"string", "max":350, "min":0, "pattern":"^\\P{C}*$" }, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"TagKey", "documentation":"

The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.

" }, "value":{ "shape":"TagValue", "documentation":"

The value associated with the tag. The value may be an empty string but it can't be null.

" } }, "documentation":"

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: _ . : / = + - @.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tags" ], "members":{ "resourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.

", "location":"uri", "locationName":"resourceARN" }, "tags":{ "shape":"Tags", "documentation":"

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.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":200, "min":0 }, "TextDocumentStatistics":{ "type":"structure", "members":{ "indexedTextBytes":{ "shape":"IndexedTextBytes", "documentation":"

The total size, in bytes, of the indexed documents.

" }, "indexedTextDocumentCount":{ "shape":"IndexedTextDocument", "documentation":"

The number of text documents indexed.

" } }, "documentation":"

Provides information about text documents in an index.

" }, "TextSegment":{ "type":"structure", "members":{ "beginOffset":{ "shape":"Integer", "documentation":"

The zero-based location in the response string where the source attribution starts.

" }, "endOffset":{ "shape":"Integer", "documentation":"

The zero-based location in the response string where the source attribution ends.

" } }, "documentation":"

Provides information about a text extract in a chat response that can be attributed to a source document.

" }, "TextSegmentList":{ "type":"list", "member":{"shape":"TextSegment"} }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The request was denied due to throttling. Reduce the number of requests and try again.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Timestamp":{"type":"timestamp"}, "Title":{ "type":"string", "max":1024, "min":1 }, "TopicConfiguration":{ "type":"structure", "required":[ "name", "rules" ], "members":{ "description":{ "shape":"TopicDescription", "documentation":"

A description for your topic control configuration. Use this outline how the large language model (LLM) should use this topic control configuration.

" }, "exampleChatMessages":{ "shape":"ExampleChatMessages", "documentation":"

A list of example phrases that you expect the end user to use in relation to the topic.

" }, "name":{ "shape":"TopicConfigurationName", "documentation":"

A name for your topic control configuration.

" }, "rules":{ "shape":"Rules", "documentation":"

Rules defined for a topic configuration.

" } }, "documentation":"

The topic specific controls configured for an Amazon Q application.

" }, "TopicConfigurationName":{ "type":"string", "max":36, "min":1, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{0,35}$" }, "TopicConfigurations":{ "type":"list", "member":{"shape":"TopicConfiguration"}, "max":10, "min":0 }, "TopicDescription":{ "type":"string", "max":350, "min":0, "pattern":"^\\P{C}*$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tagKeys" ], "members":{ "resourceARN":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.

", "location":"uri", "locationName":"resourceARN" }, "tagKeys":{ "shape":"TagKeys", "documentation":"

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.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "attachmentsConfiguration":{ "shape":"AttachmentsConfiguration", "documentation":"

An option to allow end users to upload files directly during chat.

" }, "description":{ "shape":"Description", "documentation":"

A description for the Amazon Q application.

" }, "displayName":{ "shape":"ApplicationName", "documentation":"

A name for the Amazon Q application.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q permission to access Amazon CloudWatch logs and metrics.

" } } }, "UpdateApplicationResponse":{ "type":"structure", "members":{ } }, "UpdateChatControlsConfigurationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application for which the chat controls are configured.

", "location":"uri", "locationName":"applicationId" }, "blockedPhrasesConfigurationUpdate":{ "shape":"BlockedPhrasesConfigurationUpdate", "documentation":"

The phrases blocked from chat by your chat control configuration.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that you provide to identify the request to update a Amazon Q application chat configuration.

", "idempotencyToken":true }, "responseScope":{ "shape":"ResponseScope", "documentation":"

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.

" }, "topicConfigurationsToCreateOrUpdate":{ "shape":"TopicConfigurations", "documentation":"

The configured topic specific chat controls you want to update.

" }, "topicConfigurationsToDelete":{ "shape":"TopicConfigurations", "documentation":"

The configured topic specific chat controls you want to delete.

" } } }, "UpdateChatControlsConfigurationResponse":{ "type":"structure", "members":{ } }, "UpdateDataSourceRequest":{ "type":"structure", "required":[ "applicationId", "dataSourceId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application the data source is attached to.

", "location":"uri", "locationName":"applicationId" }, "configuration":{"shape":"DataSourceConfiguration"}, "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source connector.

", "location":"uri", "locationName":"dataSourceId" }, "description":{ "shape":"Description", "documentation":"

The description of the data source connector.

" }, "displayName":{ "shape":"DataSourceName", "documentation":"

A name of the data source connector.

" }, "documentEnrichmentConfiguration":{"shape":"DocumentEnrichmentConfiguration"}, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index attached to the data source connector.

", "location":"uri", "locationName":"indexId" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

" }, "syncSchedule":{ "shape":"SyncSchedule", "documentation":"

The chosen update frequency for your data source.

" }, "vpcConfiguration":{"shape":"DataSourceVpcConfiguration"} } }, "UpdateDataSourceResponse":{ "type":"structure", "members":{ } }, "UpdateIndexRequest":{ "type":"structure", "required":[ "applicationId", "indexId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application connected to the index.

", "location":"uri", "locationName":"applicationId" }, "capacityConfiguration":{ "shape":"IndexCapacityConfiguration", "documentation":"

The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.

" }, "description":{ "shape":"Description", "documentation":"

The description of the Amazon Q index.

" }, "displayName":{ "shape":"ApplicationName", "documentation":"

The name of the Amazon Q index.

" }, "documentAttributeConfigurations":{ "shape":"DocumentAttributeConfigurations", "documentation":"

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.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the Amazon Q index.

", "location":"uri", "locationName":"indexId" } } }, "UpdateIndexResponse":{ "type":"structure", "members":{ } }, "UpdatePluginRequest":{ "type":"structure", "required":[ "applicationId", "pluginId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application the plugin is attached to.

", "location":"uri", "locationName":"applicationId" }, "authConfiguration":{ "shape":"PluginAuthConfiguration", "documentation":"

The authentication configuration the plugin is using.

" }, "displayName":{ "shape":"PluginName", "documentation":"

The name of the plugin.

" }, "pluginId":{ "shape":"PluginId", "documentation":"

The identifier of the plugin.

", "location":"uri", "locationName":"pluginId" }, "serverUrl":{ "shape":"Url", "documentation":"

The source URL used for plugin configuration.

" }, "state":{ "shape":"PluginState", "documentation":"

The status of the plugin.

" } } }, "UpdatePluginResponse":{ "type":"structure", "members":{ } }, "UpdateRetrieverRequest":{ "type":"structure", "required":[ "applicationId", "retrieverId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of your Amazon Q application.

", "location":"uri", "locationName":"applicationId" }, "configuration":{"shape":"RetrieverConfiguration"}, "displayName":{ "shape":"RetrieverName", "documentation":"

The name of your retriever.

" }, "retrieverId":{ "shape":"RetrieverId", "documentation":"

The identifier of your retriever.

", "location":"uri", "locationName":"retrieverId" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.

" } } }, "UpdateRetrieverResponse":{ "type":"structure", "members":{ } }, "UpdateUserRequest":{ "type":"structure", "required":[ "applicationId", "userId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the application the user is attached to.

", "location":"uri", "locationName":"applicationId" }, "userAliasesToDelete":{ "shape":"UserAliases", "documentation":"

The user aliases attached to the user id that are to be deleted.

" }, "userAliasesToUpdate":{ "shape":"UserAliases", "documentation":"

The user aliases attached to the user id that are to be updated.

" }, "userId":{ "shape":"String", "documentation":"

The email id attached to the user.

", "location":"uri", "locationName":"userId" } } }, "UpdateUserResponse":{ "type":"structure", "members":{ "userAliasesAdded":{ "shape":"UserAliases", "documentation":"

The user aliases that have been to be added to a user id.

" }, "userAliasesDeleted":{ "shape":"UserAliases", "documentation":"

The user aliases that have been deleted from a user id.

" }, "userAliasesUpdated":{ "shape":"UserAliases", "documentation":"

The user aliases attached to a user id that have been updated.

" } } }, "UpdateWebExperienceRequest":{ "type":"structure", "required":[ "applicationId", "webExperienceId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The identifier of the Amazon Q application attached to the web experience.

", "location":"uri", "locationName":"applicationId" }, "authenticationConfiguration":{ "shape":"WebExperienceAuthConfiguration", "documentation":"

The authentication configuration of the Amazon Q web experience.

" }, "samplePromptsControlMode":{ "shape":"WebExperienceSamplePromptsControlMode", "documentation":"

Determines whether sample prompts are enabled in the web experience for an end user.

" }, "subtitle":{ "shape":"WebExperienceSubtitle", "documentation":"

The subtitle of the Amazon Q web experience.

" }, "title":{ "shape":"WebExperienceTitle", "documentation":"

The title of the Amazon Q web experience.

" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of the Amazon Q web experience.

", "location":"uri", "locationName":"webExperienceId" }, "welcomeMessage":{ "shape":"WebExperienceWelcomeMessage", "documentation":"

A customized welcome message for an end user in an Amazon Q web experience.

" } } }, "UpdateWebExperienceResponse":{ "type":"structure", "members":{ } }, "Url":{ "type":"string", "max":2048, "min":1, "pattern":"^(https?|ftp|file)://([^\\s]*)$" }, "UserAlias":{ "type":"structure", "required":["userId"], "members":{ "dataSourceId":{ "shape":"DataSourceId", "documentation":"

The identifier of the data source that the user aliases are associated with.

" }, "indexId":{ "shape":"IndexId", "documentation":"

The identifier of the index that the user aliases are associated with.

" }, "userId":{ "shape":"String", "documentation":"

The identifier of the user id associated with the user aliases.

" } }, "documentation":"

Aliases attached to a user id within an Amazon Q application.

" }, "UserAliases":{ "type":"list", "member":{"shape":"UserAlias"} }, "UserGroups":{ "type":"list", "member":{"shape":"String"} }, "UserId":{ "type":"string", "max":1024, "min":1, "pattern":"^\\P{C}*$" }, "UserIds":{ "type":"list", "member":{"shape":"String"} }, "UserMessage":{ "type":"string", "max":7000, "min":1 }, "UsersAndGroups":{ "type":"structure", "members":{ "userGroups":{ "shape":"UserGroups", "documentation":"

The user groups associated with a topic control rule.

" }, "userIds":{ "shape":"UserIds", "documentation":"

The user ids associated with a topic control rule.

" } }, "documentation":"

Provides information about users and groups associated with a topic control rule.

" }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "fields":{ "shape":"ValidationExceptionFields", "documentation":"

The input field(s) that failed validation.

" }, "message":{ "shape":"ErrorMessage", "documentation":"

The message describing the `ValidationException`.

" }, "reason":{ "shape":"ValidationExceptionReason", "documentation":"

The reason for the `ValidationException`.

" } }, "documentation":"

The input doesn't meet the constraints set by the Amazon Q service. Provide the correct input and try again.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "message", "name" ], "members":{ "message":{ "shape":"String", "documentation":"

A message about the validation exception.

" }, "name":{ "shape":"String", "documentation":"

The field name where the invalid entry was detected.

" } }, "documentation":"

The input failed to meet the constraints specified by Amazon Q in a specified field.

" }, "ValidationExceptionFields":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "CANNOT_PARSE", "FIELD_VALIDATION_FAILED", "UNKNOWN_OPERATION" ] }, "WebExperience":{ "type":"structure", "members":{ "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when the Amazon Q application was last updated.

" }, "defaultEndpoint":{ "shape":"Url", "documentation":"

The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully hosted by Amazon Web Services.

" }, "status":{ "shape":"WebExperienceStatus", "documentation":"

The status of your Amazon Q web experience.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp when your Amazon Q web experience was updated.

" }, "webExperienceId":{ "shape":"WebExperienceId", "documentation":"

The identifier of your Amazon Q web experience.

" } }, "documentation":"

Provides information for an Amazon Q web experience.

" }, "WebExperienceArn":{ "type":"string", "max":1284, "min":0, "pattern":"^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" }, "WebExperienceAuthConfiguration":{ "type":"structure", "members":{ "samlConfiguration":{"shape":"SamlConfiguration"} }, "documentation":"

Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.

", "union":true }, "WebExperienceId":{ "type":"string", "max":36, "min":36, "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*$" }, "WebExperienceSamplePromptsControlMode":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "WebExperienceStatus":{ "type":"string", "enum":[ "CREATING", "ACTIVE", "DELETING", "FAILED", "PENDING_AUTH_CONFIG" ] }, "WebExperienceSubtitle":{ "type":"string", "max":500, "min":0, "pattern":"^\\P{C}*$" }, "WebExperienceTitle":{ "type":"string", "max":500, "min":0, "pattern":"^\\P{C}*$" }, "WebExperienceWelcomeMessage":{ "type":"string", "max":300, "min":0 }, "WebExperiences":{ "type":"list", "member":{"shape":"WebExperience"} } }, "documentation":"

" }