Amazon Q is in preview release and is subject to change.
This is the Amazon Q (for business use) API Reference.
-Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
-you can deploy within your organization. Amazon Q enhances employee productivity by
-supporting key tasks such as question-answering, knowledge discovery, writing email
-messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
-ask questions of Amazon Q and get answers that are presented in a conversational
-manner. For an introduction to the service, see the
-Amazon Q (for business use) Developer
-Guide
+ This is the Amazon Q Business API Reference. Amazon Q Business is a fully
+managed, generative-AI powered enterprise chat assistant that you can deploy within your
+organization. Amazon Q Business enhances employee productivity by supporting key tasks such
+as question-answering, knowledge discovery, writing email messages, summarizing text,
+drafting document outlines, and brainstorming ideas. Users ask questions of
+Amazon Q Business and get answers that are presented in a conversational manner. For an
+introduction to the service, see the
+Amazon Q Business User Guide
. For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations. For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations. For information about the IAM access control permissions you need to
-use this API, see IAM roles for Amazon Q in the
-Amazon Q (for business use) Developer Guide. You can use the following AWS SDKs to access Amazon Q APIs:
You can use the following AWS SDKs to access Amazon Q Business APIs:
@@ -63,21 +62,21 @@ JavaScript
The following resources provide additional information about using the Amazon Q +
The following resources provide additional information about using the Amazon Q Business API:
Setting up for -Amazon Q +Amazon Q Business
Amazon Q is in preview release and is subject to change.
*This is the Amazon Q (for business use) API Reference.
- * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
- * you can deploy within your organization. Amazon Q enhances employee productivity by
- * supporting key tasks such as question-answering, knowledge discovery, writing email
- * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
- * ask questions of Amazon Q and get answers that are presented in a conversational
- * manner. For an introduction to the service, see the
- * Amazon Q (for business use) Developer
- * Guide
+ * This is the Amazon Q Business API Reference. Amazon Q Business is a fully
+ * managed, generative-AI powered enterprise chat assistant that you can deploy within your
+ * organization. Amazon Q Business enhances employee productivity by supporting key tasks such
+ * as question-answering, knowledge discovery, writing email messages, summarizing text,
+ * drafting document outlines, and brainstorming ideas. Users ask questions of
+ * Amazon Q Business and get answers that are presented in a conversational manner. For an
+ * introduction to the service, see the
+ * Amazon Q Business User Guide
* . For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations. For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations. For information about the IAM access control permissions you need to
- * use this API, see IAM roles for Amazon Q in the
- * Amazon Q (for business use) Developer Guide. You can use the following AWS SDKs to access Amazon Q APIs:
You can use the following AWS SDKs to access Amazon Q Business APIs:
*@@ -1087,21 +1086,21 @@ export interface QBusiness { *
*The following resources provide additional information about using the Amazon Q + *
The following resources provide additional information about using the Amazon Q Business * API:
** * Setting up for - * Amazon Q + * Amazon Q Business * *
** - * Amazon Q CLI Reference + * Amazon Q Business CLI Reference * *
*Amazon Q is in preview release and is subject to change.
*This is the Amazon Q (for business use) API Reference.
- * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
- * you can deploy within your organization. Amazon Q enhances employee productivity by
- * supporting key tasks such as question-answering, knowledge discovery, writing email
- * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
- * ask questions of Amazon Q and get answers that are presented in a conversational
- * manner. For an introduction to the service, see the
- * Amazon Q (for business use) Developer
- * Guide
+ * This is the Amazon Q Business API Reference. Amazon Q Business is a fully
+ * managed, generative-AI powered enterprise chat assistant that you can deploy within your
+ * organization. Amazon Q Business enhances employee productivity by supporting key tasks such
+ * as question-answering, knowledge discovery, writing email messages, summarizing text,
+ * drafting document outlines, and brainstorming ideas. Users ask questions of
+ * Amazon Q Business and get answers that are presented in a conversational manner. For an
+ * introduction to the service, see the
+ * Amazon Q Business User Guide
* . For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations. For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations. For information about the IAM access control permissions you need to
- * use this API, see IAM roles for Amazon Q in the
- * Amazon Q (for business use) Developer Guide. You can use the following AWS SDKs to access Amazon Q APIs:
You can use the following AWS SDKs to access Amazon Q Business APIs:
*@@ -501,21 +500,21 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo *
*The following resources provide additional information about using the Amazon Q + *
The following resources provide additional information about using the Amazon Q Business * API:
** * Setting up for - * Amazon Q + * Amazon Q Business * *
** - * Amazon Q CLI Reference + * Amazon Q Business CLI Reference * *
*Asynchronously deletes one or more documents added using the
- * BatchPutDocument API from an Amazon Q index.
BatchPutDocument API from an Amazon Q Business index.
* You can see the progress of the deletion, and any error messages related to the * process, by using CloudWatch.
* @example @@ -79,7 +79,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -91,7 +91,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts b/clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts index e50f55de24ba..c6406f697650 100644 --- a/clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts +++ b/clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts @@ -27,18 +27,18 @@ export interface BatchPutDocumentCommandInput extends BatchPutDocumentRequest {} export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, __MetadataBearer {} /** - *Adds one or more documents to an Amazon Q index.
+ *Adds one or more documents to an Amazon Q Business index.
*You use this API to:
*ingest your structured and unstructured documents and documents stored in an - * Amazon S3 bucket into an Amazon Q index.
+ * Amazon S3 bucket into an Amazon Q Business index. *add custom attributes to documents in an Amazon Q index.
+ *add custom attributes to documents in an Amazon Q Business index.
*attach an access control list to the documents added to an Amazon Q + *
attach an access control list to the documents added to an Amazon Q Business * index.
*An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -196,14 +196,14 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ChatSyncCommand.ts b/clients/client-qbusiness/src/commands/ChatSyncCommand.ts index bae0119b1097..9bec835d2d2a 100644 --- a/clients/client-qbusiness/src/commands/ChatSyncCommand.ts +++ b/clients/client-qbusiness/src/commands/ChatSyncCommand.ts @@ -27,7 +27,7 @@ export interface ChatSyncCommandInput extends ChatSyncInput {} export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer {} /** - *Starts or continues a non-streaming Amazon Q conversation.
+ *Starts or continues a non-streaming Amazon Q Business conversation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -36,7 +36,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer * const client = new QBusinessClient(config); * const input = { // ChatSyncInput * applicationId: "STRING_VALUE", // required - * userId: "STRING_VALUE", // required + * userId: "STRING_VALUE", * userGroups: [ // UserGroups * "STRING_VALUE", * ], @@ -139,6 +139,12 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer * lessThan: "An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link LicenseNotFoundException} (client fault) @@ -228,7 +234,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts b/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts index cb5106c11f5f..ff4f5aaeea1f 100644 --- a/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts @@ -31,7 +31,7 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest export interface CreateApplicationCommandOutput extends CreateApplicationResponse, __MetadataBearer {} /** - *Creates an Amazon Q application.
+ *Creates an Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -41,6 +41,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons * const input = { // CreateApplicationRequest * displayName: "STRING_VALUE", // required * roleArn: "STRING_VALUE", // required + * identityCenterInstanceArn: "STRING_VALUE", * description: "STRING_VALUE", * encryptionConfiguration: { // EncryptionConfiguration * kmsKeyId: "STRING_VALUE", @@ -80,7 +81,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -88,14 +89,14 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateDataSourceCommand.ts b/clients/client-qbusiness/src/commands/CreateDataSourceCommand.ts index 07b05d5dad2e..28a7393caa60 100644 --- a/clients/client-qbusiness/src/commands/CreateDataSourceCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface CreateDataSourceCommandInput extends CreateDataSourceRequest {} export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, __MetadataBearer {} /** - *Creates a data source connector for an Amazon Q application.
+ *Creates a data source connector for an Amazon Q Business application.
*
* CreateDataSource is a synchronous operation. The operation returns 200 if
* the data source was successfully created. Otherwise, an exception is raised.
An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -158,14 +158,14 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateIndexCommand.ts b/clients/client-qbusiness/src/commands/CreateIndexCommand.ts index 0b71e4fcdd56..9265c4867f24 100644 --- a/clients/client-qbusiness/src/commands/CreateIndexCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateIndexCommand.ts @@ -27,7 +27,7 @@ export interface CreateIndexCommandInput extends CreateIndexRequest {} export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {} /** - *Creates an Amazon Q index.
+ *Creates an Amazon Q Business index.
*To determine if index creation has completed, check the Status field
* returned from a call to DescribeIndex. The Status field is set
* to ACTIVE when the index is ready to use.
An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -89,14 +89,14 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreatePluginCommand.ts b/clients/client-qbusiness/src/commands/CreatePluginCommand.ts index 8adcbd6d2cef..00a835741ed8 100644 --- a/clients/client-qbusiness/src/commands/CreatePluginCommand.ts +++ b/clients/client-qbusiness/src/commands/CreatePluginCommand.ts @@ -27,7 +27,7 @@ export interface CreatePluginCommandInput extends CreatePluginRequest {} export interface CreatePluginCommandOutput extends CreatePluginResponse, __MetadataBearer {} /** - *Creates an Amazon Q plugin.
+ *Creates an Amazon Q Business plugin.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -81,7 +81,7 @@ export interface CreatePluginCommandOutput extends CreatePluginResponse, __Metad * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -89,14 +89,14 @@ export interface CreatePluginCommandOutput extends CreatePluginResponse, __Metad * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts b/clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts index 438f62ac0b48..2113deb1f2dd 100644 --- a/clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateRetrieverCommand.ts @@ -27,7 +27,7 @@ export interface CreateRetrieverCommandInput extends CreateRetrieverRequest {} export interface CreateRetrieverCommandOutput extends CreateRetrieverResponse, __MetadataBearer {} /** - *Adds a retriever to your Amazon Q application.
+ *Adds a retriever to your Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -100,7 +100,7 @@ export interface CreateRetrieverCommandOutput extends CreateRetrieverResponse, _ * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -108,14 +108,14 @@ export interface CreateRetrieverCommandOutput extends CreateRetrieverResponse, _ * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateUserCommand.ts b/clients/client-qbusiness/src/commands/CreateUserCommand.ts index 491dbd32f2d7..a3cbfe0fdde2 100644 --- a/clients/client-qbusiness/src/commands/CreateUserCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateUserCommand.ts @@ -68,7 +68,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -76,14 +76,14 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/CreateWebExperienceCommand.ts b/clients/client-qbusiness/src/commands/CreateWebExperienceCommand.ts index 37a08868c15f..3e3801f82427 100644 --- a/clients/client-qbusiness/src/commands/CreateWebExperienceCommand.ts +++ b/clients/client-qbusiness/src/commands/CreateWebExperienceCommand.ts @@ -27,7 +27,7 @@ export interface CreateWebExperienceCommandInput extends CreateWebExperienceRequ export interface CreateWebExperienceCommandOutput extends CreateWebExperienceResponse, __MetadataBearer {} /** - *Creates an Amazon Q web experience.
+ *Creates an Amazon Q Business web experience.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -40,6 +40,7 @@ export interface CreateWebExperienceCommandOutput extends CreateWebExperienceRes * subtitle: "STRING_VALUE", * welcomeMessage: "STRING_VALUE", * samplePromptsControlMode: "ENABLED" || "DISABLED", + * roleArn: "STRING_VALUE", * tags: [ // Tags * { // Tag * key: "STRING_VALUE", // required @@ -72,7 +73,7 @@ export interface CreateWebExperienceCommandOutput extends CreateWebExperienceRes * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -80,14 +81,14 @@ export interface CreateWebExperienceCommandOutput extends CreateWebExperienceRes * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteApplicationCommand.ts b/clients/client-qbusiness/src/commands/DeleteApplicationCommand.ts index a4690940c201..93b9be99a353 100644 --- a/clients/client-qbusiness/src/commands/DeleteApplicationCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteApplicationCommand.ts @@ -27,7 +27,7 @@ export interface DeleteApplicationCommandInput extends DeleteApplicationRequest export interface DeleteApplicationCommandOutput extends DeleteApplicationResponse, __MetadataBearer {} /** - *Deletes an Amazon Q application.
+ *Deletes an Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -58,7 +58,7 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -70,7 +70,7 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteChatControlsConfigurationCommand.ts b/clients/client-qbusiness/src/commands/DeleteChatControlsConfigurationCommand.ts index 27cee1d10f08..0845537ae2af 100644 --- a/clients/client-qbusiness/src/commands/DeleteChatControlsConfigurationCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteChatControlsConfigurationCommand.ts @@ -32,7 +32,7 @@ export interface DeleteChatControlsConfigurationCommandOutput __MetadataBearer {} /** - *Deletes chat controls configured for an existing Amazon Q application.
+ *Deletes chat controls configured for an existing Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,7 @@ export interface DeleteChatControlsConfigurationCommandOutput * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeleteChatControlsConfigurationCommandOutput * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteConversationCommand.ts b/clients/client-qbusiness/src/commands/DeleteConversationCommand.ts index 05b60098a010..7c62287cbcbc 100644 --- a/clients/client-qbusiness/src/commands/DeleteConversationCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteConversationCommand.ts @@ -27,7 +27,7 @@ export interface DeleteConversationCommandInput extends DeleteConversationReques export interface DeleteConversationCommandOutput extends DeleteConversationResponse, __MetadataBearer {} /** - *Deletes an Amazon Q web experience conversation.
+ *Deletes an Amazon Q Business web experience conversation.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -37,7 +37,7 @@ export interface DeleteConversationCommandOutput extends DeleteConversationRespo * const input = { // DeleteConversationRequest * conversationId: "STRING_VALUE", // required * applicationId: "STRING_VALUE", // required - * userId: "STRING_VALUE", // required + * userId: "STRING_VALUE", * }; * const command = new DeleteConversationCommand(input); * const response = await client.send(command); @@ -56,7 +56,7 @@ export interface DeleteConversationCommandOutput extends DeleteConversationRespo * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link LicenseNotFoundException} (client fault) @@ -72,7 +72,7 @@ export interface DeleteConversationCommandOutput extends DeleteConversationRespo * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteDataSourceCommand.ts b/clients/client-qbusiness/src/commands/DeleteDataSourceCommand.ts index ab6c3d62dc3b..3eb4e341d89d 100644 --- a/clients/client-qbusiness/src/commands/DeleteDataSourceCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface DeleteDataSourceCommandInput extends DeleteDataSourceRequest {} export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, __MetadataBearer {} /** - *Deletes an Amazon Q data source connector. While the data source is being + *
Deletes an Amazon Q Business data source connector. While the data source is being
* deleted, the Status field returned by a call to the
* DescribeDataSource API is set to DELETING.
An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -74,7 +74,7 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteGroupCommand.ts b/clients/client-qbusiness/src/commands/DeleteGroupCommand.ts index fd5e607c36c9..8546c34602b5 100644 --- a/clients/client-qbusiness/src/commands/DeleteGroupCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteGroupCommand.ts @@ -69,7 +69,7 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -81,7 +81,7 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteIndexCommand.ts b/clients/client-qbusiness/src/commands/DeleteIndexCommand.ts index ba8cc7df6cc8..c6e2b7336878 100644 --- a/clients/client-qbusiness/src/commands/DeleteIndexCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteIndexCommand.ts @@ -27,7 +27,7 @@ export interface DeleteIndexCommandInput extends DeleteIndexRequest {} export interface DeleteIndexCommandOutput extends DeleteIndexResponse, __MetadataBearer {} /** - *Deletes an Amazon Q index.
+ *Deletes an Amazon Q Business index.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,7 @@ export interface DeleteIndexCommandOutput extends DeleteIndexResponse, __Metadat * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeleteIndexCommandOutput extends DeleteIndexResponse, __Metadat * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeletePluginCommand.ts b/clients/client-qbusiness/src/commands/DeletePluginCommand.ts index 4f66bdbd5f25..f4e4bdc3790c 100644 --- a/clients/client-qbusiness/src/commands/DeletePluginCommand.ts +++ b/clients/client-qbusiness/src/commands/DeletePluginCommand.ts @@ -27,7 +27,7 @@ export interface DeletePluginCommandInput extends DeletePluginRequest {} export interface DeletePluginCommandOutput extends DeletePluginResponse, __MetadataBearer {} /** - *Deletes an Amazon Q plugin.
+ *Deletes an Amazon Q Business plugin.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,7 @@ export interface DeletePluginCommandOutput extends DeletePluginResponse, __Metad * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeletePluginCommandOutput extends DeletePluginResponse, __Metad * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteRetrieverCommand.ts b/clients/client-qbusiness/src/commands/DeleteRetrieverCommand.ts index e40cd5397e3d..2afb06e6f45c 100644 --- a/clients/client-qbusiness/src/commands/DeleteRetrieverCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteRetrieverCommand.ts @@ -27,7 +27,7 @@ export interface DeleteRetrieverCommandInput extends DeleteRetrieverRequest {} export interface DeleteRetrieverCommandOutput extends DeleteRetrieverResponse, __MetadataBearer {} /** - *Deletes the retriever used by an Amazon Q application.
+ *Deletes the retriever used by an Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,7 @@ export interface DeleteRetrieverCommandOutput extends DeleteRetrieverResponse, _ * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeleteRetrieverCommandOutput extends DeleteRetrieverResponse, _ * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteUserCommand.ts b/clients/client-qbusiness/src/commands/DeleteUserCommand.ts index 3f849dfba68a..d74dab17c4da 100644 --- a/clients/client-qbusiness/src/commands/DeleteUserCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteUserCommand.ts @@ -59,7 +59,7 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/DeleteWebExperienceCommand.ts b/clients/client-qbusiness/src/commands/DeleteWebExperienceCommand.ts index 9519238ff036..3ad08ed482cc 100644 --- a/clients/client-qbusiness/src/commands/DeleteWebExperienceCommand.ts +++ b/clients/client-qbusiness/src/commands/DeleteWebExperienceCommand.ts @@ -27,7 +27,7 @@ export interface DeleteWebExperienceCommandInput extends DeleteWebExperienceRequ export interface DeleteWebExperienceCommandOutput extends DeleteWebExperienceResponse, __MetadataBearer {} /** - *Deletes an Amazon Q web experience.
+ *Deletes an Amazon Q Business web experience.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,7 +59,7 @@ export interface DeleteWebExperienceCommandOutput extends DeleteWebExperienceRes * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,7 +71,7 @@ export interface DeleteWebExperienceCommandOutput extends DeleteWebExperienceRes * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetApplicationCommand.ts b/clients/client-qbusiness/src/commands/GetApplicationCommand.ts index 7112e491ea7f..1c507ea82f64 100644 --- a/clients/client-qbusiness/src/commands/GetApplicationCommand.ts +++ b/clients/client-qbusiness/src/commands/GetApplicationCommand.ts @@ -31,7 +31,7 @@ export interface GetApplicationCommandInput extends GetApplicationRequest {} export interface GetApplicationCommandOutput extends GetApplicationResponse, __MetadataBearer {} /** - *Gets information about an existing Amazon Q application.
+ *Gets information about an existing Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -47,6 +47,7 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M * // displayName: "STRING_VALUE", * // applicationId: "STRING_VALUE", * // applicationArn: "STRING_VALUE", + * // identityCenterApplicationArn: "STRING_VALUE", * // roleArn: "STRING_VALUE", * // status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING", * // description: "STRING_VALUE", @@ -77,7 +78,7 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -89,7 +90,7 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts b/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts index af242b8bc86a..0277d9e79bc1 100644 --- a/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts +++ b/clients/client-qbusiness/src/commands/GetChatControlsConfigurationCommand.ts @@ -32,7 +32,7 @@ export interface GetChatControlsConfigurationCommandOutput __MetadataBearer {} /** - *Gets information about an chat controls configured for an existing Amazon Q + *
Gets information about an chat controls configured for an existing Amazon Q Business * application.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -98,6 +98,9 @@ export interface GetChatControlsConfigurationCommandOutput * // ], * // }, * // ], + * // creatorModeConfiguration: { // AppliedCreatorModeConfiguration + * // creatorModeControl: "ENABLED" || "DISABLED", // required + * // }, * // nextToken: "STRING_VALUE", * // }; * @@ -114,7 +117,7 @@ export interface GetChatControlsConfigurationCommandOutput * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -126,7 +129,7 @@ export interface GetChatControlsConfigurationCommandOutput * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetDataSourceCommand.ts b/clients/client-qbusiness/src/commands/GetDataSourceCommand.ts index 3e7bcbe9162f..d83f50dac275 100644 --- a/clients/client-qbusiness/src/commands/GetDataSourceCommand.ts +++ b/clients/client-qbusiness/src/commands/GetDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface GetDataSourceCommandInput extends GetDataSourceRequest {} export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __MetadataBearer {} /** - *Gets information about an existing Amazon Q data source connector.
+ *Gets information about an existing Amazon Q Business data source connector.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -147,7 +147,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -159,7 +159,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetGroupCommand.ts b/clients/client-qbusiness/src/commands/GetGroupCommand.ts index 48b9a2cba228..80775e7a8c3f 100644 --- a/clients/client-qbusiness/src/commands/GetGroupCommand.ts +++ b/clients/client-qbusiness/src/commands/GetGroupCommand.ts @@ -80,7 +80,7 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -92,7 +92,7 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetIndexCommand.ts b/clients/client-qbusiness/src/commands/GetIndexCommand.ts index 6867bcf0f9e3..010333e86055 100644 --- a/clients/client-qbusiness/src/commands/GetIndexCommand.ts +++ b/clients/client-qbusiness/src/commands/GetIndexCommand.ts @@ -27,7 +27,7 @@ export interface GetIndexCommandInput extends GetIndexRequest {} export interface GetIndexCommandOutput extends GetIndexResponse, __MetadataBearer {} /** - *Gets information about an existing Amazon Q index.
+ *Gets information about an existing Amazon Q Business index.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -84,7 +84,7 @@ export interface GetIndexCommandOutput extends GetIndexResponse, __MetadataBeare * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -96,7 +96,7 @@ export interface GetIndexCommandOutput extends GetIndexResponse, __MetadataBeare * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetPluginCommand.ts b/clients/client-qbusiness/src/commands/GetPluginCommand.ts index 44a41faf6893..b60722ba09de 100644 --- a/clients/client-qbusiness/src/commands/GetPluginCommand.ts +++ b/clients/client-qbusiness/src/commands/GetPluginCommand.ts @@ -27,7 +27,7 @@ export interface GetPluginCommandInput extends GetPluginRequest {} export interface GetPluginCommandOutput extends GetPluginResponse, __MetadataBearer {} /** - *Gets information about an existing Amazon Q plugin.
+ *Gets information about an existing Amazon Q Business plugin.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,7 +75,7 @@ export interface GetPluginCommandOutput extends GetPluginResponse, __MetadataBea * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -87,7 +87,7 @@ export interface GetPluginCommandOutput extends GetPluginResponse, __MetadataBea * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetRetrieverCommand.ts b/clients/client-qbusiness/src/commands/GetRetrieverCommand.ts index d0aadd9aa6db..af474f280f82 100644 --- a/clients/client-qbusiness/src/commands/GetRetrieverCommand.ts +++ b/clients/client-qbusiness/src/commands/GetRetrieverCommand.ts @@ -27,7 +27,7 @@ export interface GetRetrieverCommandInput extends GetRetrieverRequest {} export interface GetRetrieverCommandOutput extends GetRetrieverResponse, __MetadataBearer {} /** - *Gets information about an existing retriever used by an Amazon Q + *
Gets information about an existing retriever used by an Amazon Q Business * application.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -95,7 +95,7 @@ export interface GetRetrieverCommandOutput extends GetRetrieverResponse, __Metad * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -107,7 +107,7 @@ export interface GetRetrieverCommandOutput extends GetRetrieverResponse, __Metad * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetUserCommand.ts b/clients/client-qbusiness/src/commands/GetUserCommand.ts index 8f3eef46a1f1..996ad1adadd9 100644 --- a/clients/client-qbusiness/src/commands/GetUserCommand.ts +++ b/clients/client-qbusiness/src/commands/GetUserCommand.ts @@ -68,7 +68,7 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -80,7 +80,7 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/GetWebExperienceCommand.ts b/clients/client-qbusiness/src/commands/GetWebExperienceCommand.ts index e19dfa4e956c..7ba4230ee3e2 100644 --- a/clients/client-qbusiness/src/commands/GetWebExperienceCommand.ts +++ b/clients/client-qbusiness/src/commands/GetWebExperienceCommand.ts @@ -27,7 +27,7 @@ export interface GetWebExperienceCommandInput extends GetWebExperienceRequest {} export interface GetWebExperienceCommandOutput extends GetWebExperienceResponse, __MetadataBearer {} /** - *Gets information about an existing Amazon Q web experience.
+ *Gets information about an existing Amazon Q Business web experience.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -52,6 +52,7 @@ export interface GetWebExperienceCommandOutput extends GetWebExperienceResponse, * // subtitle: "STRING_VALUE", * // welcomeMessage: "STRING_VALUE", * // samplePromptsControlMode: "ENABLED" || "DISABLED", + * // roleArn: "STRING_VALUE", * // authenticationConfiguration: { // WebExperienceAuthConfiguration Union: only one key present * // samlConfiguration: { // SamlConfiguration * // metadataXML: "STRING_VALUE", // required @@ -79,7 +80,7 @@ export interface GetWebExperienceCommandOutput extends GetWebExperienceResponse, * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -91,7 +92,7 @@ export interface GetWebExperienceCommandOutput extends GetWebExperienceResponse, * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListApplicationsCommand.ts b/clients/client-qbusiness/src/commands/ListApplicationsCommand.ts index 1576609925bf..a546c7d3b7e4 100644 --- a/clients/client-qbusiness/src/commands/ListApplicationsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListApplicationsCommand.ts @@ -27,7 +27,7 @@ export interface ListApplicationsCommandInput extends ListApplicationsRequest {} export interface ListApplicationsCommandOutput extends ListApplicationsResponse, __MetadataBearer {} /** - *Lists Amazon Q applications.
+ *Lists Amazon Q Business applications.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -66,7 +66,7 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ThrottlingException} (client fault) @@ -74,7 +74,7 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListConversationsCommand.ts b/clients/client-qbusiness/src/commands/ListConversationsCommand.ts index 14b38a34863b..9750c2220773 100644 --- a/clients/client-qbusiness/src/commands/ListConversationsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListConversationsCommand.ts @@ -27,7 +27,7 @@ export interface ListConversationsCommandInput extends ListConversationsRequest export interface ListConversationsCommandOutput extends ListConversationsResponse, __MetadataBearer {} /** - *Lists one or more Amazon Q conversations.
+ *Lists one or more Amazon Q Business conversations.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -36,7 +36,7 @@ export interface ListConversationsCommandOutput extends ListConversationsRespons * const client = new QBusinessClient(config); * const input = { // ListConversationsRequest * applicationId: "STRING_VALUE", // required - * userId: "STRING_VALUE", // required + * userId: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; @@ -66,7 +66,7 @@ export interface ListConversationsCommandOutput extends ListConversationsRespons * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link LicenseNotFoundException} (client fault) @@ -82,7 +82,7 @@ export interface ListConversationsCommandOutput extends ListConversationsRespons * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListDataSourceSyncJobsCommand.ts b/clients/client-qbusiness/src/commands/ListDataSourceSyncJobsCommand.ts index e6d5585d26e0..04375b50fade 100644 --- a/clients/client-qbusiness/src/commands/ListDataSourceSyncJobsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListDataSourceSyncJobsCommand.ts @@ -27,7 +27,7 @@ export interface ListDataSourceSyncJobsCommandInput extends ListDataSourceSyncJo export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJobsResponse, __MetadataBearer {} /** - *Get information about an Amazon Q data source connector synchronization.
+ *Get information about an Amazon Q Business data source connector synchronization.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -83,7 +83,7 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -95,7 +95,7 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListDataSourcesCommand.ts b/clients/client-qbusiness/src/commands/ListDataSourcesCommand.ts index 01ca37471d81..f4fdfaff94a9 100644 --- a/clients/client-qbusiness/src/commands/ListDataSourcesCommand.ts +++ b/clients/client-qbusiness/src/commands/ListDataSourcesCommand.ts @@ -27,7 +27,7 @@ export interface ListDataSourcesCommandInput extends ListDataSourcesRequest {} export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, __MetadataBearer {} /** - *Lists the Amazon Q data source connectors that you have created.
+ *Lists the Amazon Q Business data source connectors that you have created.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,7 +69,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -81,7 +81,7 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListDocumentsCommand.ts b/clients/client-qbusiness/src/commands/ListDocumentsCommand.ts index 83f2101b6839..df94d90f699e 100644 --- a/clients/client-qbusiness/src/commands/ListDocumentsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListDocumentsCommand.ts @@ -74,7 +74,7 @@ export interface ListDocumentsCommandOutput extends ListDocumentsResponse, __Met * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -86,7 +86,7 @@ export interface ListDocumentsCommandOutput extends ListDocumentsResponse, __Met * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListGroupsCommand.ts b/clients/client-qbusiness/src/commands/ListGroupsCommand.ts index caa8a5c6496f..aafe26791b07 100644 --- a/clients/client-qbusiness/src/commands/ListGroupsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListGroupsCommand.ts @@ -70,7 +70,7 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -82,7 +82,7 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListIndicesCommand.ts b/clients/client-qbusiness/src/commands/ListIndicesCommand.ts index 909a9ce00080..c847c60de171 100644 --- a/clients/client-qbusiness/src/commands/ListIndicesCommand.ts +++ b/clients/client-qbusiness/src/commands/ListIndicesCommand.ts @@ -27,7 +27,7 @@ export interface ListIndicesCommandInput extends ListIndicesRequest {} export interface ListIndicesCommandOutput extends ListIndicesResponse, __MetadataBearer {} /** - *Lists the Amazon Q indices you have created.
+ *Lists the Amazon Q Business indices you have created.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,7 +67,7 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -79,7 +79,7 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListMessagesCommand.ts b/clients/client-qbusiness/src/commands/ListMessagesCommand.ts index 7ca984598695..5b2852e2d95e 100644 --- a/clients/client-qbusiness/src/commands/ListMessagesCommand.ts +++ b/clients/client-qbusiness/src/commands/ListMessagesCommand.ts @@ -27,7 +27,7 @@ export interface ListMessagesCommandInput extends ListMessagesRequest {} export interface ListMessagesCommandOutput extends ListMessagesResponse, __MetadataBearer {} /** - *Gets a list of messages associated with an Amazon Q web experience.
+ *Gets a list of messages associated with an Amazon Q Business web experience.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -37,7 +37,7 @@ export interface ListMessagesCommandOutput extends ListMessagesResponse, __Metad * const input = { // ListMessagesRequest * conversationId: "STRING_VALUE", // required * applicationId: "STRING_VALUE", // required - * userId: "STRING_VALUE", // required + * userId: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; @@ -122,7 +122,7 @@ export interface ListMessagesCommandOutput extends ListMessagesResponse, __Metad * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link LicenseNotFoundException} (client fault) @@ -138,7 +138,7 @@ export interface ListMessagesCommandOutput extends ListMessagesResponse, __Metad * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListPluginsCommand.ts b/clients/client-qbusiness/src/commands/ListPluginsCommand.ts index 37915c46ea3d..989e0f872957 100644 --- a/clients/client-qbusiness/src/commands/ListPluginsCommand.ts +++ b/clients/client-qbusiness/src/commands/ListPluginsCommand.ts @@ -27,7 +27,7 @@ export interface ListPluginsCommandInput extends ListPluginsRequest {} export interface ListPluginsCommandOutput extends ListPluginsResponse, __MetadataBearer {} /** - *Lists configured Amazon Q plugins.
+ *Lists configured Amazon Q Business plugins.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,7 +69,7 @@ export interface ListPluginsCommandOutput extends ListPluginsResponse, __Metadat * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -81,7 +81,7 @@ export interface ListPluginsCommandOutput extends ListPluginsResponse, __Metadat * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListRetrieversCommand.ts b/clients/client-qbusiness/src/commands/ListRetrieversCommand.ts index da10670addd4..47a8ecdb9bf1 100644 --- a/clients/client-qbusiness/src/commands/ListRetrieversCommand.ts +++ b/clients/client-qbusiness/src/commands/ListRetrieversCommand.ts @@ -27,7 +27,7 @@ export interface ListRetrieversCommandInput extends ListRetrieversRequest {} export interface ListRetrieversCommandOutput extends ListRetrieversResponse, __MetadataBearer {} /** - *Lists the retriever used by an Amazon Q application.
+ *Lists the retriever used by an Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,7 +67,7 @@ export interface ListRetrieversCommandOutput extends ListRetrieversResponse, __M * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -79,7 +79,7 @@ export interface ListRetrieversCommandOutput extends ListRetrieversResponse, __M * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListTagsForResourceCommand.ts b/clients/client-qbusiness/src/commands/ListTagsForResourceCommand.ts index 528593e99821..ac82dd854b65 100644 --- a/clients/client-qbusiness/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-qbusiness/src/commands/ListTagsForResourceCommand.ts @@ -27,7 +27,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - *Gets a list of tags associated with a specified resource. Amazon Q applications + *
Gets a list of tags associated with a specified resource. Amazon Q Business applications * and data sources can have tags associated with them.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -62,7 +62,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -74,7 +74,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/ListWebExperiencesCommand.ts b/clients/client-qbusiness/src/commands/ListWebExperiencesCommand.ts index 5e9ba9deb657..f35249960521 100644 --- a/clients/client-qbusiness/src/commands/ListWebExperiencesCommand.ts +++ b/clients/client-qbusiness/src/commands/ListWebExperiencesCommand.ts @@ -27,7 +27,7 @@ export interface ListWebExperiencesCommandInput extends ListWebExperiencesReques export interface ListWebExperiencesCommandOutput extends ListWebExperiencesResponse, __MetadataBearer {} /** - *Lists one or more Amazon Q Web Experiences.
+ *Lists one or more Amazon Q Business Web Experiences.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,7 +67,7 @@ export interface ListWebExperiencesCommandOutput extends ListWebExperiencesRespo * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -79,7 +79,7 @@ export interface ListWebExperiencesCommandOutput extends ListWebExperiencesRespo * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts b/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts index 5c2182687de3..c813b63f6fa3 100644 --- a/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts +++ b/clients/client-qbusiness/src/commands/PutFeedbackCommand.ts @@ -27,7 +27,7 @@ export interface PutFeedbackCommandInput extends PutFeedbackRequest {} export interface PutFeedbackCommandOutput extends __MetadataBearer {} /** - *Enables your end user to to provide feedback on their Amazon Q generated chat + *
Enables your end user to provide feedback on their Amazon Q Business generated chat * responses.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -37,7 +37,7 @@ export interface PutFeedbackCommandOutput extends __MetadataBearer {} * const client = new QBusinessClient(config); * const input = { // PutFeedbackRequest * applicationId: "STRING_VALUE", // required - * userId: "STRING_VALUE", // required + * userId: "STRING_VALUE", * conversationId: "STRING_VALUE", // required * messageId: "STRING_VALUE", // required * messageCopiedAt: new Date("TIMESTAMP"), @@ -65,7 +65,7 @@ export interface PutFeedbackCommandOutput extends __MetadataBearer {} * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -77,7 +77,7 @@ export interface PutFeedbackCommandOutput extends __MetadataBearer {} * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/PutGroupCommand.ts b/clients/client-qbusiness/src/commands/PutGroupCommand.ts index 5343cbb587a3..a3e774412f15 100644 --- a/clients/client-qbusiness/src/commands/PutGroupCommand.ts +++ b/clients/client-qbusiness/src/commands/PutGroupCommand.ts @@ -33,7 +33,7 @@ export interface PutGroupCommandOutput extends PutGroupResponse, __MetadataBeare * 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. + * can see top-secret company documents in their Amazon Q Business chat results. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -82,7 +82,7 @@ export interface PutGroupCommandOutput extends PutGroupResponse, __MetadataBeare * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -90,14 +90,14 @@ export interface PutGroupCommandOutput extends PutGroupResponse, __MetadataBeare * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/StartDataSourceSyncJobCommand.ts b/clients/client-qbusiness/src/commands/StartDataSourceSyncJobCommand.ts index 75183eebe5cf..4bb8f33dddea 100644 --- a/clients/client-qbusiness/src/commands/StartDataSourceSyncJobCommand.ts +++ b/clients/client-qbusiness/src/commands/StartDataSourceSyncJobCommand.ts @@ -28,7 +28,7 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync /** *Starts a data source connector synchronization job. If a synchronization job is
- * already in progress, Amazon Q returns a ConflictException.
ConflictException.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -63,7 +63,7 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
* resource. Fix any inconsistences with your resources and try again.
*
* @throws {@link InternalServerException} (server fault)
- * An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -71,14 +71,14 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/StopDataSourceSyncJobCommand.ts b/clients/client-qbusiness/src/commands/StopDataSourceSyncJobCommand.ts index 45b92a33e247..0e7828582e2c 100644 --- a/clients/client-qbusiness/src/commands/StopDataSourceSyncJobCommand.ts +++ b/clients/client-qbusiness/src/commands/StopDataSourceSyncJobCommand.ts @@ -27,7 +27,7 @@ export interface StopDataSourceSyncJobCommandInput extends StopDataSourceSyncJob export interface StopDataSourceSyncJobCommandOutput extends StopDataSourceSyncJobResponse, __MetadataBearer {} /** - *Stops an Amazon Q data source connector synchronization job already in + *
Stops an Amazon Q Business data source connector synchronization job already in * progress.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -57,7 +57,7 @@ export interface StopDataSourceSyncJobCommandOutput extends StopDataSourceSyncJo * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -69,7 +69,7 @@ export interface StopDataSourceSyncJobCommandOutput extends StopDataSourceSyncJo * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/TagResourceCommand.ts b/clients/client-qbusiness/src/commands/TagResourceCommand.ts index 2fdecf983022..95fdabceebf1 100644 --- a/clients/client-qbusiness/src/commands/TagResourceCommand.ts +++ b/clients/client-qbusiness/src/commands/TagResourceCommand.ts @@ -27,7 +27,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *Adds the specified tag to the specified Amazon Q application or data source + *
Adds the specified tag to the specified Amazon Q Business application or data source * resource. If the tag already exists, the existing value is replaced with the new * value.
* @example @@ -66,7 +66,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -78,7 +78,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UntagResourceCommand.ts b/clients/client-qbusiness/src/commands/UntagResourceCommand.ts index 125fcd54d037..c093bf1da17d 100644 --- a/clients/client-qbusiness/src/commands/UntagResourceCommand.ts +++ b/clients/client-qbusiness/src/commands/UntagResourceCommand.ts @@ -27,7 +27,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *Removes a tag from an Amazon Q application or a data source.
+ *Removes a tag from an Amazon Q Business application or a data source.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,7 +57,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -69,7 +69,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts b/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts index 1d99626496c9..a101d117b75d 100644 --- a/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts @@ -27,7 +27,7 @@ export interface UpdateApplicationCommandInput extends UpdateApplicationRequest export interface UpdateApplicationCommandOutput extends UpdateApplicationResponse, __MetadataBearer {} /** - *Updates an existing Amazon Q application.
+ *Updates an existing Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,7 +64,7 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -76,7 +76,7 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts b/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts index 34078706cee6..45cec0e6818d 100644 --- a/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateChatControlsConfigurationCommand.ts @@ -32,7 +32,7 @@ export interface UpdateChatControlsConfigurationCommandOutput __MetadataBearer {} /** - *Updates an set of chat controls configured for an existing Amazon Q + *
Updates an set of chat controls configured for an existing Amazon Q Business * application.
* @example * Use a bare-bones client and the command you need to make an API call. @@ -139,6 +139,9 @@ export interface UpdateChatControlsConfigurationCommandOutput * ], * }, * ], + * creatorModeConfiguration: { // CreatorModeConfiguration + * creatorModeControl: "ENABLED" || "DISABLED", // required + * }, * }; * const command = new UpdateChatControlsConfigurationCommand(input); * const response = await client.send(command); @@ -161,7 +164,7 @@ export interface UpdateChatControlsConfigurationCommandOutput * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -169,14 +172,14 @@ export interface UpdateChatControlsConfigurationCommandOutput * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateDataSourceCommand.ts b/clients/client-qbusiness/src/commands/UpdateDataSourceCommand.ts index b4fe011690fc..514f07db353d 100644 --- a/clients/client-qbusiness/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface UpdateDataSourceCommandInput extends UpdateDataSourceRequest {} export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, __MetadataBearer {} /** - *Updates an existing Amazon Q data source connector.
+ *Updates an existing Amazon Q Business data source connector.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -138,7 +138,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -150,7 +150,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateIndexCommand.ts b/clients/client-qbusiness/src/commands/UpdateIndexCommand.ts index 8036735093e2..9d28d2b6d90a 100644 --- a/clients/client-qbusiness/src/commands/UpdateIndexCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateIndexCommand.ts @@ -27,7 +27,7 @@ export interface UpdateIndexCommandInput extends UpdateIndexRequest {} export interface UpdateIndexCommandOutput extends UpdateIndexResponse, __MetadataBearer {} /** - *Updates an Amazon Q index.
+ *Updates an Amazon Q Business index.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,7 +71,7 @@ export interface UpdateIndexCommandOutput extends UpdateIndexResponse, __Metadat * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -79,14 +79,14 @@ export interface UpdateIndexCommandOutput extends UpdateIndexResponse, __Metadat * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdatePluginCommand.ts b/clients/client-qbusiness/src/commands/UpdatePluginCommand.ts index 18e1142578ce..5a0ba339d58f 100644 --- a/clients/client-qbusiness/src/commands/UpdatePluginCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdatePluginCommand.ts @@ -27,7 +27,7 @@ export interface UpdatePluginCommandInput extends UpdatePluginRequest {} export interface UpdatePluginCommandOutput extends UpdatePluginResponse, __MetadataBearer {} /** - *Updates an Amazon Q plugin.
+ *Updates an Amazon Q Business plugin.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,7 +72,7 @@ export interface UpdatePluginCommandOutput extends UpdatePluginResponse, __Metad * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -80,14 +80,14 @@ export interface UpdatePluginCommandOutput extends UpdatePluginResponse, __Metad * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateRetrieverCommand.ts b/clients/client-qbusiness/src/commands/UpdateRetrieverCommand.ts index 81125de0c7b5..34d197933833 100644 --- a/clients/client-qbusiness/src/commands/UpdateRetrieverCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateRetrieverCommand.ts @@ -27,7 +27,7 @@ export interface UpdateRetrieverCommandInput extends UpdateRetrieverRequest {} export interface UpdateRetrieverCommandOutput extends UpdateRetrieverResponse, __MetadataBearer {} /** - *Updates the retriever used for your Amazon Q application.
+ *Updates the retriever used for your Amazon Q Business application.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -90,7 +90,7 @@ export interface UpdateRetrieverCommandOutput extends UpdateRetrieverResponse, _ * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -98,14 +98,14 @@ export interface UpdateRetrieverCommandOutput extends UpdateRetrieverResponse, _ * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateUserCommand.ts b/clients/client-qbusiness/src/commands/UpdateUserCommand.ts index 432c43247c37..4a1d42f67238 100644 --- a/clients/client-qbusiness/src/commands/UpdateUserCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateUserCommand.ts @@ -91,7 +91,7 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB * permission policies and user accounts and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -99,14 +99,14 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB * resource and try again. * * @throws {@link ServiceQuotaExceededException} (client fault) - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* * @throws {@link ThrottlingException} (client fault) *The request was denied due to throttling. Reduce the number of requests and try * again.
* * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/commands/UpdateWebExperienceCommand.ts b/clients/client-qbusiness/src/commands/UpdateWebExperienceCommand.ts index e617bddb1b93..1dfcd024bd1a 100644 --- a/clients/client-qbusiness/src/commands/UpdateWebExperienceCommand.ts +++ b/clients/client-qbusiness/src/commands/UpdateWebExperienceCommand.ts @@ -27,7 +27,7 @@ export interface UpdateWebExperienceCommandInput extends UpdateWebExperienceRequ export interface UpdateWebExperienceCommandOutput extends UpdateWebExperienceResponse, __MetadataBearer {} /** - *Updates an Amazon Q web experience.
+ *Updates an Amazon Q Business web experience.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,7 +71,7 @@ export interface UpdateWebExperienceCommandOutput extends UpdateWebExperienceRes * resource. Fix any inconsistences with your resources and try again. * * @throws {@link InternalServerException} (server fault) - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* * @throws {@link ResourceNotFoundException} (client fault) @@ -83,7 +83,7 @@ export interface UpdateWebExperienceCommandOutput extends UpdateWebExperienceRes * again. * * @throws {@link ValidationException} (client fault) - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* * @throws {@link QBusinessServiceException} diff --git a/clients/client-qbusiness/src/index.ts b/clients/client-qbusiness/src/index.ts index 458e314b2ce7..3eeb46b86120 100644 --- a/clients/client-qbusiness/src/index.ts +++ b/clients/client-qbusiness/src/index.ts @@ -4,21 +4,20 @@ *Amazon Q is in preview release and is subject to change.
*This is the Amazon Q (for business use) API Reference.
- * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
- * you can deploy within your organization. Amazon Q enhances employee productivity by
- * supporting key tasks such as question-answering, knowledge discovery, writing email
- * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
- * ask questions of Amazon Q and get answers that are presented in a conversational
- * manner. For an introduction to the service, see the
- * Amazon Q (for business use) Developer
- * Guide
+ * This is the Amazon Q Business API Reference. Amazon Q Business is a fully
+ * managed, generative-AI powered enterprise chat assistant that you can deploy within your
+ * organization. Amazon Q Business enhances employee productivity by supporting key tasks such
+ * as question-answering, knowledge discovery, writing email messages, summarizing text,
+ * drafting document outlines, and brainstorming ideas. Users ask questions of
+ * Amazon Q Business and get answers that are presented in a conversational manner. For an
+ * introduction to the service, see the
+ * Amazon Q Business User Guide
* . For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations. For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations. For information about the IAM access control permissions you need to
- * use this API, see IAM roles for Amazon Q in the
- * Amazon Q (for business use) Developer Guide. You can use the following AWS SDKs to access Amazon Q APIs:
You can use the following AWS SDKs to access Amazon Q Business APIs:
*@@ -58,21 +57,21 @@ *
*The following resources provide additional information about using the Amazon Q + *
The following resources provide additional information about using the Amazon Q Business * API:
** * Setting up for - * Amazon Q + * Amazon Q Business * *
** - * Amazon Q CLI Reference + * Amazon Q Business CLI Reference * *
*Provides user and group information used for filtering documents to use for generating - * Amazon Q conversation responses.
+ * Amazon Q Business conversation responses. * @public */ export type Principal = Principal.GroupMember | Principal.UserMember | Principal.$UnknownMember; @@ -222,7 +222,7 @@ export interface ActionExecutionPayloadField { } /** - *Performs an Amazon Q plugin action during a non-streaming chat + *
Performs an Amazon Q Business plugin action during a non-streaming chat * conversation.
* @public */ @@ -235,7 +235,7 @@ export interface ActionExecution { /** *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.
+ * Amazon Q Business requests to perform their plugin action. * @public */ payload: RecordInformation about the field values that an end user can use to provide to - * Amazon Q for Amazon Q to perform the requested plugin action.
+ * Amazon Q Business for Amazon Q Business to perform the requested plugin action. * @public */ export interface ActionReviewPayloadFieldAllowedValue { @@ -314,7 +314,7 @@ export interface ActionReviewPayloadField { /** *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.
+ * Amazon Q Business for Amazon Q Business to perform the requested plugin action. * @public */ allowedValues?: ActionReviewPayloadFieldAllowedValue[]; @@ -343,10 +343,10 @@ export const PluginType = { export type PluginType = (typeof PluginType)[keyof typeof PluginType]; /** - *An output event that Amazon Q returns to an user who wants to perform a plugin + *
An output event that Amazon Q Business returns to an user who wants to perform a plugin * action during a non-streaming chat conversation. It contains information about the * selected action with a list of possible user input fields, some pre-populated by - * Amazon Q.
+ * Amazon Q Business. * @public */ export interface ActionReview { @@ -363,7 +363,7 @@ export interface ActionReview { pluginType?: PluginType; /** - *Field values that an end user needs to provide to Amazon Q for Amazon Q to + *
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to * perform the requested plugin action.
* @public */ @@ -395,36 +395,36 @@ export const ApplicationStatus = { export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus]; /** - *Summary information for an Amazon Q application.
+ *Summary information for an Amazon Q Business application.
* @public */ export interface Application { /** - *The name of the Amazon Q application.
+ *The name of the Amazon Q Business application.
* @public */ displayName?: string; /** - *The identifier for the Amazon Q application.
+ *The identifier for the Amazon Q Business application.
* @public */ applicationId?: string; /** - *The Unix timestamp when the Amazon Q application was created.
+ *The Unix timestamp when the Amazon Q Business application was created.
* @public */ createdAt?: Date; /** - *The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ updatedAt?: Date; /** - *The status of the Amazon Q application. The application is ready to use when the + *
The status of the Amazon Q Business application. The application is ready to use when the
* status is ACTIVE.
Provides the identifier of the KMS key used to encrypt data indexed by - * Amazon Q. Amazon Q doesn't support asymmetric keys.
+ * Amazon Q Business. Amazon Q Business doesn't support asymmetric keys. * @public */ export interface EncryptionConfiguration { /** - *The identifier of the KMS key. Amazon Q doesn't support asymmetric + *
The identifier of the KMS key. Amazon Q Business doesn't support asymmetric * keys.
* @public */ @@ -516,7 +516,7 @@ export interface EncryptionConfiguration { export interface Tag { /** *The key for the tag. Keys are not case sensitive and must be unique for the - * Amazon Q application or data source.
+ * Amazon Q Business application or data source. * @public */ key: string | undefined; @@ -534,7 +534,7 @@ export interface Tag { */ export interface CreateApplicationRequest { /** - *A name for the Amazon Q application.
+ *A name for the Amazon Q Business application.
* @public */ displayName: string | undefined; @@ -547,20 +547,27 @@ export interface CreateApplicationRequest { roleArn: string | undefined; /** - *A description for the Amazon Q application.
+ *The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either + * creating for—or connecting to—your Amazon Q Business application.
+ * @public + */ + identityCenterInstanceArn?: string; + + /** + *A description for the Amazon Q Business application.
* @public */ description?: string; /** *The identifier of the KMS key that is used to encrypt your data. - * Amazon Q doesn't support asymmetric keys.
+ * Amazon Q Business doesn't support asymmetric keys. * @public */ encryptionConfiguration?: EncryptionConfiguration; /** - *A list of key-value pairs that identify or categorize your Amazon Q application. + *
A list of key-value pairs that identify or categorize your Amazon Q Business application. * You can also use tags to help control access to the application. Tag keys and values can * consist of Unicode letters, digits, white space, and any of the following symbols: _ . : * / = + - @.
@@ -569,7 +576,7 @@ export interface CreateApplicationRequest { tags?: Tag[]; /** - *A token that you provide to identify the request to create your Amazon Q + *
A token that you provide to identify the request to create your Amazon Q Business * application.
* @public */ @@ -587,20 +594,20 @@ export interface CreateApplicationRequest { */ export interface CreateApplicationResponse { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId?: string; /** - *The Amazon Resource Name (ARN) of the Amazon Q application.
+ *The Amazon Resource Name (ARN) of the Amazon Q Business application.
* @public */ applicationArn?: string; } /** - *An issue occurred with the internal server used for your Amazon Q service. Wait + *
An issue occurred with the internal server used for your Amazon Q Business service. Wait * some minutes and try again, or contact Support for help.
* @public */ @@ -656,7 +663,7 @@ export class ResourceNotFoundException extends __BaseException { } /** - *You have exceeded the set limits for your Amazon Q service.
+ *You have exceeded the set limits for your Amazon Q Business service.
* @public */ export class ServiceQuotaExceededException extends __BaseException { @@ -711,7 +718,7 @@ export class ThrottlingException extends __BaseException { } /** - *The input failed to meet the constraints specified by Amazon Q in a specified + *
The input failed to meet the constraints specified by Amazon Q Business in a specified * field.
* @public */ @@ -745,7 +752,7 @@ export const ValidationExceptionReason = { export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; /** - *The input doesn't meet the constraints set by the Amazon Q service. Provide the + *
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the * correct input and try again.
* @public */ @@ -784,7 +791,7 @@ export class ValidationException extends __BaseException { */ export interface DeleteApplicationRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; @@ -800,7 +807,7 @@ export interface DeleteApplicationResponse {} */ export interface GetApplicationRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; @@ -859,23 +866,30 @@ export interface ErrorDetail { */ export interface GetApplicationResponse { /** - *The name of the Amazon Q application.
+ *The name of the Amazon Q Business application.
* @public */ displayName?: string; /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId?: string; /** - *The Amazon Resource Name (ARN) of the Amazon Q application.
+ *The Amazon Resource Name (ARN) of the Amazon Q Business application.
* @public */ applicationArn?: string; + /** + *The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to + * your Amazon Q Business application.
+ * @public + */ + identityCenterApplicationArn?: string; + /** *The Amazon Resource Name (ARN) of the IAM with permissions to access * your CloudWatch logs and metrics.
@@ -884,33 +898,33 @@ export interface GetApplicationResponse { roleArn?: string; /** - *The status of the Amazon Q application.
+ *The status of the Amazon Q Business application.
* @public */ status?: ApplicationStatus; /** - *A description for the Amazon Q application.
+ *A description for the Amazon Q Business application.
* @public */ description?: string; /** *The identifier of the Amazon Web Services - * KMS key that is used to encrypt your data. Amazon Q doesn't support + * KMS key that is used to encrypt your data. Amazon Q Business doesn't support * asymmetric keys.
* @public */ encryptionConfiguration?: EncryptionConfiguration; /** - *The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ createdAt?: Date; /** - *The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ updatedAt?: Date; @@ -936,7 +950,7 @@ export interface GetApplicationResponse { */ export interface IndexCapacityConfiguration { /** - *The number of storage units configured for an Amazon Q index.
+ *The number of storage units configured for an Amazon Q Business index.
* @public */ units?: number; @@ -947,19 +961,19 @@ export interface IndexCapacityConfiguration { */ export interface CreateIndexRequest { /** - *The identifier of the Amazon Q application using the index.
+ *The identifier of the Amazon Q Business application using the index.
* @public */ applicationId: string | undefined; /** - *A name for the Amazon Q index.
+ *A name for the Amazon Q Business index.
* @public */ displayName: string | undefined; /** - *A description for the Amazon Q index.
+ *A description for the Amazon Q Business index.
* @public */ description?: string; @@ -993,13 +1007,13 @@ export interface CreateIndexRequest { */ export interface CreateIndexResponse { /** - *The identifier for the Amazon Q index.
+ *The identifier for the Amazon Q Business index.
* @public */ indexId?: string; /** - *The Amazon Resource Name (ARN) of an Amazon Q index.
+ *The Amazon Resource Name (ARN) of an Amazon Q Business index.
* @public */ indexArn?: string; @@ -1126,7 +1140,7 @@ export namespace DocumentAttributeValue { /** *The condition used for the target document attribute or metadata field when ingesting
- * documents into Amazon Q. You use this with
+ * documents into Amazon Q Business. You use this with
* DocumentAttributeTarget
* to apply the condition.
For example, you can create the 'Department' target field and have it prefill @@ -1134,9 +1148,9 @@ export namespace DocumentAttributeValue { * 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 + *
Amazon Q Business can't create a target field if it has not already been created as an
* index field. After you create your index field, you can create a document metadata field
- * using DocumentAttributeTarget. Amazon Q then will map your newly
+ * using DocumentAttributeTarget. Amazon Q Business then will map your newly
* created metadata field to your index field.
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
+ *
Amazon Q Business currently doesn't support _document_body as an attribute
* key used for the condition.
The target document attribute or metadata field you want to alter when ingesting - * documents into Amazon Q.
+ * documents into Amazon Q Business. *For example, you can delete all customer identification numbers associated with the
* documents, stored in the document metadata field called 'Customer_ID' by setting the
* target key as 'Customer_ID' and the deletion flag to TRUE. This removes all
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
* information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an + *
Amazon Q Business can't create a target field if it has not already been created as an
* index field. After you create your index field, you can create a document metadata field
* using
* DocumentAttributeTarget
- * . Amazon Q
+ * . Amazon Q Business
* will then map your newly created document attribute to your index field.
To apply advanced logic, to go beyond what you can do with basic logic, see
* HookConfiguration
* .
The condition used for the target document attribute or metadata field when ingesting
- * documents into Amazon Q. You use this with
+ * documents into Amazon Q Business. You use this with
* DocumentAttributeTarget
* to apply the condition.
For example, you can create the 'Department' target field and have it prefill @@ -1260,9 +1274,9 @@ export interface InlineDocumentEnrichmentConfiguration { * 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 + *
Amazon Q Business can't create a target field if it has not already been created as an
* index field. After you create your index field, you can create a document metadata field
- * using DocumentAttributeTarget. Amazon Q then will map your newly
+ * using DocumentAttributeTarget. Amazon Q Business then will map your newly
* created metadata field to your index field.
The target document attribute or metadata field you want to alter when ingesting - * documents into Amazon Q.
+ * documents into Amazon Q Business. *For example, you can delete all customer identification numbers associated with the
* documents, stored in the document metadata field called 'Customer_ID' by setting the
* target key as 'Customer_ID' and the deletion flag to TRUE. This removes all
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
* information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an + *
Amazon Q Business can't create a target field if it has not already been created as an
* index field. After you create your index field, you can create a document metadata field
* using
* DocumentAttributeTarget
- * . Amazon Q
+ * . Amazon Q Business
* will then map your newly created document attribute to your index field.
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, + *
If you want to apply advanced alterations on the Amazon Q Business structured documents, * you must configure your Lambda function using PostExtractionHookConfiguration.
*You can only invoke one Lambda function. However, this function can invoke * other functions it requires.
@@ -1315,7 +1329,7 @@ export interface HookConfiguration { /** *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.
+ * then Amazon Q Business should invoke a function that inserts the current date-time. * @public */ invocationCondition?: DocumentAttributeCondition; @@ -1355,7 +1369,7 @@ export interface HookConfiguration { export interface DocumentEnrichmentConfiguration { /** *Configuration information to alter document attributes or metadata fields and content - * when ingesting documents into Amazon Q.
+ * when ingesting documents into Amazon Q Business. * @public */ inlineConfigurations?: InlineDocumentEnrichmentConfiguration[]; @@ -1363,10 +1377,10 @@ export interface DocumentEnrichmentConfiguration { /** *Provides the configuration information for invoking a Lambda function in * Lambda to alter document metadata and content when ingesting - * documents into Amazon Q.
+ * documents into Amazon Q Business. *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, + *
If you want to apply advanced alterations on the Amazon Q Business structured documents, * you must configure your Lambda function using PostExtractionHookConfiguration.
*You can only invoke one Lambda function. However, this function can invoke * other functions it requires.
@@ -1378,10 +1392,10 @@ export interface DocumentEnrichmentConfiguration { /** *Provides the configuration information for invoking a Lambda function in * Lambda to alter document metadata and content when ingesting - * documents into Amazon Q.
+ * documents into Amazon Q Business. *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, + *
If you want to apply advanced alterations on the Amazon Q Business structured documents, * you must configure your Lambda function using PostExtractionHookConfiguration.
*You can only invoke one Lambda function. However, this function can invoke * other functions it requires.
@@ -1407,7 +1421,7 @@ export interface DataSourceVpcConfiguration { /** *A list of identifiers of security groups within your Amazon VPC. The security - * groups should enable Amazon Q to connect to the data source.
+ * groups should enable Amazon Q Business to connect to the data source. * @public */ securityGroupIds: string[] | undefined; @@ -1418,7 +1432,7 @@ export interface DataSourceVpcConfiguration { */ export interface CreateDataSourceRequest { /** - *The identifier of the Amazon Q application the data source will be attached + *
The identifier of the Amazon Q Business application the data source will be attached * to.
* @public */ @@ -1439,7 +1453,7 @@ export interface CreateDataSourceRequest { /** *Configuration information to connect to your data source repository. For configuration - * templates for your specific data source, see Supported + * templates for your specific data source, see Supported * connectors.
* @public */ @@ -1448,7 +1462,7 @@ export interface CreateDataSourceRequest { /** *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.
+ * Amazon VPC with Amazon Q Business connectors. * @public */ vpcConfiguration?: DataSourceVpcConfiguration; @@ -1469,8 +1483,8 @@ export interface CreateDataSourceRequest { tags?: Tag[]; /** - *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 + *
Sets the frequency for Amazon Q Business to check the documents in your data source + * repository and update your index. If you don't set a schedule, Amazon Q Business won't * periodically update the index.
*Specify a cron- format schedule string or an empty string to indicate
* that the index is updated on demand. You can't specify the Schedule
@@ -1516,7 +1530,7 @@ export interface CreateDataSourceResponse {
dataSourceId?: string;
/**
- *
The Amazon Resource Name (ARN) of a data source in an Amazon Q application. + *
The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application. *
* @public */ @@ -1528,7 +1542,7 @@ export interface CreateDataSourceResponse { */ export interface DeleteDataSourceRequest { /** - *The identifier of the Amazon Q application used with the data source + *
The identifier of the Amazon Q Business application used with the data source * connector.
* @public */ @@ -1557,7 +1571,7 @@ export interface DeleteDataSourceResponse {} */ export interface GetDataSourceRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; @@ -1598,7 +1612,7 @@ export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSource */ export interface GetDataSourceResponse { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId?: string; @@ -1673,7 +1687,7 @@ export interface GetDataSourceResponse { status?: DataSourceStatus; /** - *The schedule for Amazon Q to update the index.
+ *The schedule for Amazon Q Business to update the index.
* @public */ syncSchedule?: string; @@ -1708,7 +1722,7 @@ export interface GetDataSourceResponse { */ export interface ListDataSourcesRequest { /** - *The identifier of the Amazon Q application linked to the data source + *
The identifier of the Amazon Q Business application linked to the data source * connectors.
* @public */ @@ -1722,8 +1736,8 @@ export interface ListDataSourcesRequest { /** *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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
+ * pagination token to retrieve the next set of Amazon Q Business data source
* connectors.
A data source in an Amazon Q application.
+ *A data source in an Amazon Q Business application.
* @public */ export interface DataSource { /** - *The name of the Amazon Q data source.
+ *The name of the Amazon Q Business data source.
* @public */ displayName?: string; /** - *The identifier of the Amazon Q data source.
+ *The identifier of the Amazon Q Business data source.
* @public */ dataSourceId?: string; /** - *The type of the Amazon Q data source.
+ *The type of the Amazon Q Business data source.
* @public */ type?: string; /** - *The Unix timestamp when the Amazon Q data source was created.
+ *The Unix timestamp when the Amazon Q Business data source was created.
* @public */ createdAt?: Date; /** - *The Unix timestamp when the Amazon Q data source was last updated.
+ *The Unix timestamp when the Amazon Q Business data source was last updated.
* @public */ updatedAt?: Date; /** - *The status of the Amazon Q data source.
+ *The status of the Amazon Q Business data source.
* @public */ status?: DataSourceStatus; @@ -1789,7 +1803,7 @@ export interface ListDataSourcesResponse { dataSources?: DataSource[]; /** - *If the response is truncated, Amazon Q returns this token. You can use this token + *
If the response is truncated, Amazon Q Business returns this token. You can use this token * in a subsequent request to retrieve the next set of data source connectors.
* @public */ @@ -1801,7 +1815,7 @@ export interface ListDataSourcesResponse { */ export interface UpdateDataSourceRequest { /** - *The identifier of the Amazon Q application the data source is attached + *
The identifier of the Amazon Q Business application the data source is attached * to.
* @public */ @@ -1826,7 +1840,7 @@ export interface UpdateDataSourceRequest { displayName?: string; /** - *Provides the configuration information for an Amazon Q data source.
+ *Provides the configuration information for an Amazon Q Business data source.
* @public */ configuration?: __DocumentType; @@ -1877,14 +1891,14 @@ export interface UpdateDataSourceResponse {} */ export interface DeleteIndexRequest { /** - *The identifier of the Amazon Q application the Amazon Q index is linked + *
The identifier of the Amazon Q Business application the Amazon Q Business index is linked * to.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q index.
+ *The identifier of the Amazon Q Business index.
* @public */ indexId: string | undefined; @@ -1900,13 +1914,13 @@ export interface DeleteIndexResponse {} */ export interface GetIndexRequest { /** - *The identifier of the Amazon Q application connected to the index.
+ *The identifier of the Amazon Q Business application connected to the index.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q index you want information on.
+ *The identifier of the Amazon Q Business index you want information on.
* @public */ indexId: string | undefined; @@ -2022,25 +2036,25 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus]; */ export interface GetIndexResponse { /** - *The identifier of the Amazon Q application associated with the index.
+ *The identifier of the Amazon Q Business application associated with the index.
* @public */ applicationId?: string; /** - *The identifier of the Amazon Q index.
+ *The identifier of the Amazon Q Business index.
* @public */ indexId?: string; /** - *The name of the Amazon Q index.
+ *The name of the Amazon Q Business index.
* @public */ displayName?: string; /** - *The Amazon Resource Name (ARN) of the Amazon Q index.
+ *The Amazon Resource Name (ARN) of the Amazon Q Business index.
* @public */ indexArn?: string; @@ -2054,25 +2068,25 @@ export interface GetIndexResponse { status?: IndexStatus; /** - *The description for the Amazon Q index.
+ *The description for the Amazon Q Business index.
* @public */ description?: string; /** - *The Unix timestamp when the Amazon Q index was created.
+ *The Unix timestamp when the Amazon Q Business index was created.
* @public */ createdAt?: Date; /** - *The Unix timestamp when the Amazon Q index was last updated.
+ *The Unix timestamp when the Amazon Q Business index was last updated.
* @public */ updatedAt?: Date; /** - *The storage capacity units chosen for your Amazon Q index.
+ *The storage capacity units chosen for your Amazon Q Business index.
* @public */ capacityConfiguration?: IndexCapacityConfiguration; @@ -2104,15 +2118,15 @@ export interface GetIndexResponse { */ export interface ListIndicesRequest { /** - *The identifier of the Amazon Q application connected to the index.
+ *The identifier of the Amazon Q Business application connected to the index.
* @public */ applicationId: string | undefined; /** *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.
+ * Amazon Q Business returns a pagination token in the response. You can use this pagination + * token to retrieve the next set of Amazon Q Business indices. * @public */ nextToken?: string; @@ -2125,7 +2139,7 @@ export interface ListIndicesRequest { } /** - *Summary information for your Amazon Q index.
+ *Summary information for your Amazon Q Business index.
* @public */ export interface Index { @@ -2166,7 +2180,7 @@ export interface Index { */ export interface ListIndicesResponse { /** - *If the response is truncated, Amazon Q returns this token that you can use in the + *
If the response is truncated, Amazon Q Business returns this token that you can use in the * subsequent request to retrieve the next set of indexes.
* @public */ @@ -2184,31 +2198,31 @@ export interface ListIndicesResponse { */ export interface UpdateIndexRequest { /** - *The identifier of the Amazon Q application connected to the index.
+ *The identifier of the Amazon Q Business application connected to the index.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q index.
+ *The identifier of the Amazon Q Business index.
* @public */ indexId: string | undefined; /** - *The name of the Amazon Q index.
+ *The name of the Amazon Q Business index.
* @public */ displayName?: string; /** - *The description of the Amazon Q index.
+ *The description of the Amazon Q Business index.
* @public */ description?: string; /** - *The storage capacity units you want to provision for your Amazon Q index. You can + *
The storage capacity units you want to provision for your Amazon Q Business index. You can * add and remove capacity to fit your usage needs.
* @public */ @@ -2234,14 +2248,14 @@ export interface UpdateIndexResponse {} export interface ListApplicationsRequest { /** *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.
The maximum number of Amazon Q applications to return.
+ *The maximum number of Amazon Q Business applications to return.
* @public */ maxResults?: number; @@ -2252,14 +2266,14 @@ export interface ListApplicationsRequest { */ export interface ListApplicationsResponse { /** - *If the response is truncated, Amazon Q returns this token. You can use this token + *
If the response is truncated, Amazon Q Business returns this token. You can use this token * in a subsequent request to retrieve the next set of applications.
* @public */ nextToken?: string; /** - *An array of summary information on the configuration of one or more Amazon Q + *
An array of summary information on the configuration of one or more Amazon Q Business * applications.
* @public */ @@ -2280,7 +2294,7 @@ export interface BasicAuthConfiguration { secretArn: string | undefined; /** - *The ARN of an IAM role used by Amazon Q to access the basic + *
The ARN of an IAM role used by Amazon Q Business to access the basic * authentication credentials stored in a Secrets Manager secret.
* @public */ @@ -2301,7 +2315,7 @@ export interface OAuth2ClientCredentialConfiguration { secretArn: string | undefined; /** - *The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 + *
The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 * authentication credentials stored in a Secrets Manager secret.
* @public */ @@ -2309,7 +2323,7 @@ export interface OAuth2ClientCredentialConfiguration { } /** - *Authentication configuration information for an Amazon Q plugin.
+ *Authentication configuration information for an Amazon Q Business plugin.
* @public */ export type PluginAuthConfiguration = @@ -2395,7 +2409,7 @@ export interface CreatePluginRequest { serverUrl: string | undefined; /** - *Authentication configuration information for an Amazon Q plugin.
+ *Authentication configuration information for an Amazon Q Business plugin.
* @public */ authConfiguration: PluginAuthConfiguration | undefined; @@ -2410,7 +2424,7 @@ export interface CreatePluginRequest { tags?: Tag[]; /** - *A token that you provide to identify the request to create your Amazon Q + *
A token that you provide to identify the request to create your Amazon Q Business * plugin.
* @public */ @@ -2439,7 +2453,7 @@ export interface CreatePluginResponse { */ export interface DeletePluginRequest { /** - *The identifier the application attached to the Amazon Q plugin.
+ *The identifier the application attached to the Amazon Q Business plugin.
* @public */ applicationId: string | undefined; @@ -2522,7 +2536,7 @@ export interface GetPluginResponse { serverUrl?: string; /** - *Authentication configuration information for an Amazon Q plugin.
+ *Authentication configuration information for an Amazon Q Business plugin.
* @public */ authConfiguration?: PluginAuthConfiguration; @@ -2565,7 +2579,7 @@ export interface ListPluginsRequest { /** *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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of plugins.
Information about an Amazon Q plugin and its configuration.
+ *Information about an Amazon Q Business plugin and its configuration.
* @public */ export interface Plugin { @@ -2632,7 +2646,7 @@ export interface Plugin { export interface ListPluginsResponse { /** *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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of plugins.
Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q, see + *
For more information on how boosting document attributes work in Amazon Q Business, see * Boosting using document attributes.
* @public */ @@ -2759,7 +2773,7 @@ export type NumberAttributeBoostingType = /** *Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q, see + *
For more information on how boosting document attributes work in Amazon Q Business, see * Boosting using document attributes.
* @public */ @@ -2804,7 +2818,7 @@ export type StringAttributeValueBoostingLevel = * you can't boost attributes of these data types on either the console or the * API. * - *For more information on how boosting document attributes work in Amazon Q, see + *
For more information on how boosting document attributes work in Amazon Q Business, see * Boosting using document attributes.
* @public */ @@ -2833,7 +2847,7 @@ export interface StringAttributeBoostingConfiguration { * you can't boost attributes of these data types on either the console or the * API. * - *For more information on how boosting document attributes work in Amazon Q, see + *
For more information on how boosting document attributes work in Amazon Q Business, see * Boosting using document attributes.
* @public */ @@ -2846,9 +2860,9 @@ export interface StringListAttributeBoostingConfiguration { } /** - *Provides information on boosting supported Amazon Q document attribute types. + *
Provides information on boosting supported Amazon Q Business document attribute types. * When an end user chat query matches document attributes that have been boosted, - * Amazon Q prioritizes generating responses from content that matches the boosted + * Amazon Q Business prioritizes generating responses from content that matches the boosted * document attributes.
*For STRING and STRING_LIST type document attributes to
@@ -2857,7 +2871,7 @@ export interface StringListAttributeBoostingConfiguration {
* you can't boost attributes of these data types on either the console or the
* API.
For more information on how boosting document attributes work in Amazon Q, see + *
For more information on how boosting document attributes work in Amazon Q Business, see * Boosting using document attributes.
* @public */ @@ -2951,18 +2965,18 @@ export namespace DocumentAttributeBoostingConfiguration { } /** - *Configuration information for an Amazon Q index.
+ *Configuration information for an Amazon Q Business index.
* @public */ export interface NativeIndexConfiguration { /** - *The identifier for the Amazon Q index.
+ *The identifier for the Amazon Q Business index.
* @public */ indexId: string | undefined; /** - *Overrides the default boosts applied by Amazon Q to supported document attribute + *
Overrides the default boosts applied by Amazon Q Business to supported document attribute * data types.
* @public */ @@ -2970,7 +2984,7 @@ export interface NativeIndexConfiguration { } /** - *Provides information on how the retriever used for your Amazon Q application is + *
Provides information on how the retriever used for your Amazon Q Business application is * configured.
* @public */ @@ -2984,8 +2998,8 @@ export type RetrieverConfiguration = */ export namespace RetrieverConfiguration { /** - *Provides information on how a Amazon Q index used as a retriever for your - * Amazon Q application is configured.
+ *Provides information on how a Amazon Q Business index used as a retriever for your + * Amazon Q Business application is configured.
* @public */ export interface NativeIndexConfigurationMember { @@ -2996,7 +3010,7 @@ export namespace RetrieverConfiguration { /** *Provides information on how the Amazon Kendra index used as a retriever for your - * Amazon Q application is configured.
+ * Amazon Q Business application is configured. * @public */ export interface KendraIndexConfigurationMember { @@ -3048,7 +3062,7 @@ export type RetrieverType = (typeof RetrieverType)[keyof typeof RetrieverType]; */ export interface CreateRetrieverRequest { /** - *The identifier of your Amazon Q application.
+ *The identifier of your Amazon Q Business application.
* @public */ applicationId: string | undefined; @@ -3066,21 +3080,21 @@ export interface CreateRetrieverRequest { displayName: string | undefined; /** - *Provides information on how the retriever used for your Amazon Q application is + *
Provides information on how the retriever used for your Amazon Q Business application is * configured.
* @public */ configuration: RetrieverConfiguration | undefined; /** - *The ARN of an IAM role used by Amazon Q to access the basic + *
The ARN of an IAM role used by Amazon Q Business to access the basic * authentication credentials stored in a Secrets Manager secret.
* @public */ roleArn?: string; /** - *A token that you provide to identify the request to create your Amazon Q + *
A token that you provide to identify the request to create your Amazon Q Business * application retriever.
* @public */ @@ -3117,7 +3131,7 @@ export interface CreateRetrieverResponse { */ export interface DeleteRetrieverRequest { /** - *The identifier of the Amazon Q application using the retriever.
+ *The identifier of the Amazon Q Business application using the retriever.
* @public */ applicationId: string | undefined; @@ -3139,7 +3153,7 @@ export interface DeleteRetrieverResponse {} */ export interface GetRetrieverRequest { /** - *The identifier of the Amazon Q application using the retriever.
+ *The identifier of the Amazon Q Business application using the retriever.
* @public */ applicationId: string | undefined; @@ -3171,7 +3185,7 @@ export type RetrieverStatus = (typeof RetrieverStatus)[keyof typeof RetrieverSta */ export interface GetRetrieverResponse { /** - *The identifier of the Amazon Q application using the retriever.
+ *The identifier of the Amazon Q Business application using the retriever.
* @public */ applicationId?: string; @@ -3207,7 +3221,7 @@ export interface GetRetrieverResponse { displayName?: string; /** - *Provides information on how the retriever used for your Amazon Q application is + *
Provides information on how the retriever used for your Amazon Q Business application is * configured.
* @public */ @@ -3238,13 +3252,13 @@ export interface GetRetrieverResponse { */ export interface ListRetrieversRequest { /** - *The identifier of the Amazon Q application using the retriever.
+ *The identifier of the Amazon Q Business application using the retriever.
* @public */ applicationId: string | undefined; /** - *If the number of retrievers returned exceeds maxResults, Amazon Q
+ *
If the number of retrievers returned exceeds maxResults, Amazon Q Business
* returns a next token as a pagination token to retrieve the next set of
* retrievers.
Summary information for the retriever used for your Amazon Q application.
+ *Summary information for the retriever used for your Amazon Q Business application.
* @public */ export interface Retriever { /** - *The identifier of the Amazon Q application using the retriever.
+ *The identifier of the Amazon Q Business application using the retriever.
* @public */ applicationId?: string; /** - *The identifier of the retriever used by your Amazon Q application.
+ *The identifier of the retriever used by your Amazon Q Business application.
* @public */ retrieverId?: string; @@ -3305,7 +3319,7 @@ export interface ListRetrieversResponse { retrievers?: Retriever[]; /** - *If the response is truncated, Amazon Q returns this token, which you can use in a + *
If the response is truncated, Amazon Q Business returns this token, which you can use in a * later request to list the next set of retrievers.
* @public */ @@ -3317,7 +3331,7 @@ export interface ListRetrieversResponse { */ export interface UpdateRetrieverRequest { /** - *The identifier of your Amazon Q application.
+ *The identifier of your Amazon Q Business application.
* @public */ applicationId: string | undefined; @@ -3329,7 +3343,7 @@ export interface UpdateRetrieverRequest { retrieverId: string | undefined; /** - *Provides information on how the retriever used for your Amazon Q application is + *
Provides information on how the retriever used for your Amazon Q Business application is * configured.
* @public */ @@ -3359,26 +3373,26 @@ export interface UpdateRetrieverResponse {} */ export interface UpdateApplicationRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; /** - *A name for the Amazon Q application.
+ *A name for the Amazon Q Business application.
* @public */ displayName?: string; /** - *A description for the Amazon Q application.
+ *A description for the Amazon Q Business application.
* @public */ description?: string; /** *An Amazon Web Services Identity and Access Management (IAM) role that - * gives Amazon Q permission to access Amazon CloudWatch logs and + * gives Amazon Q Business permission to access Amazon CloudWatch logs and * metrics.
* @public */ @@ -3416,25 +3430,25 @@ export type WebExperienceSamplePromptsControlMode = */ export interface CreateWebExperienceRequest { /** - *The identifier of the Amazon Q web experience.
+ *The identifier of the Amazon Q Business web experience.
* @public */ applicationId: string | undefined; /** - *The title for your Amazon Q web experience.
+ *The title for your Amazon Q Business web experience.
* @public */ title?: string; /** - *A subtitle to personalize your Amazon Q web experience.
+ *A subtitle to personalize your Amazon Q Business web experience.
* @public */ subtitle?: string; /** - *The customized welcome message for end users of an Amazon Q web + *
The customized welcome message for end users of an Amazon Q Business web * experience.
* @public */ @@ -3448,7 +3462,14 @@ export interface CreateWebExperienceRequest { samplePromptsControlMode?: WebExperienceSamplePromptsControlMode; /** - *A list of key-value pairs that identify or categorize your Amazon Q web + *
The Amazon Resource Name (ARN) of the service role attached to your web + * experience.
+ * @public + */ + roleArn?: string; + + /** + *A list of key-value pairs that identify or categorize your Amazon Q Business web * experience. You can also use tags to help control access to the web experience. Tag keys * and values can consist of Unicode letters, digits, white space, and any of the following * symbols: _ . : / = + - @.
@@ -3457,7 +3478,7 @@ export interface CreateWebExperienceRequest { tags?: Tag[]; /** - *A token you provide to identify a request to create an Amazon Q web experience. + *
A token you provide to identify a request to create an Amazon Q Business web experience. *
* @public */ @@ -3469,13 +3490,13 @@ export interface CreateWebExperienceRequest { */ export interface CreateWebExperienceResponse { /** - *The identifier of the Amazon Q web experience.
+ *The identifier of the Amazon Q Business web experience.
* @public */ webExperienceId?: string; /** - *The Amazon Resource Name (ARN) of an Amazon Q web experience.
+ *The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
* @public */ webExperienceArn?: string; @@ -3486,14 +3507,14 @@ export interface CreateWebExperienceResponse { */ export interface DeleteWebExperienceRequest { /** - *The identifier of the Amazon Q application linked to the Amazon Q web + *
The identifier of the Amazon Q Business application linked to the Amazon Q Business web * experience.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q web experience being deleted.
+ *The identifier of the Amazon Q Business web experience being deleted.
* @public */ webExperienceId: string | undefined; @@ -3509,13 +3530,13 @@ export interface DeleteWebExperienceResponse {} */ export interface GetWebExperienceRequest { /** - *The identifier of the Amazon Q application linked to the web experience.
+ *The identifier of the Amazon Q Business application linked to the web experience.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q web experience.
+ *The identifier of the Amazon Q Business web experience.
* @public */ webExperienceId: string | undefined; @@ -3523,7 +3544,7 @@ export interface GetWebExperienceRequest { /** *Provides the SAML 2.0 compliant identity provider (IdP) configuration information - * Amazon Q needs to deploy a Amazon Q web experience.
+ * Amazon Q Business needs to deploy a Amazon Q Business web experience. * @public */ export interface SamlConfiguration { @@ -3535,8 +3556,8 @@ export interface SamlConfiguration { /** *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.
+ * they authenticate into their Amazon Q Business web experience, containing the relevant + * Amazon Q Business permissions for conversing with Amazon Q Business. * @public */ roleArn: string | undefined; @@ -3555,7 +3576,7 @@ export interface SamlConfiguration { } /** - *Provides the authorization configuration information needed to deploy a Amazon Q + *
Provides the authorization configuration information needed to deploy a Amazon Q Business * web experience to end users.
* @public */ @@ -3569,7 +3590,7 @@ export type WebExperienceAuthConfiguration = export namespace WebExperienceAuthConfiguration { /** *Provides the SAML 2.0 compliant identity provider (IdP) configuration information - * Amazon Q needs to deploy a Amazon Q web experience.
+ * Amazon Q Business needs to deploy a Amazon Q Business web experience. * @public */ export interface SamlConfigurationMember { @@ -3618,32 +3639,32 @@ export type WebExperienceStatus = (typeof WebExperienceStatus)[keyof typeof WebE */ export interface GetWebExperienceResponse { /** - *The identifier of the Amazon Q application linked to the web experience.
+ *The identifier of the Amazon Q Business application linked to the web experience.
* @public */ applicationId?: string; /** - *The identifier of the Amazon Q web experience.
+ *The identifier of the Amazon Q Business web experience.
* @public */ webExperienceId?: string; /** *The Amazon Resource Name (ARN) of the role with the permission to access the - * Amazon Q web experience and required resources.
+ * Amazon Q Business web experience and required resources. * @public */ webExperienceArn?: string; /** - *The endpoint of your Amazon Q web experience.
+ *The endpoint of your Amazon Q Business web experience.
* @public */ defaultEndpoint?: string; /** - *The current status of the Amazon Q web experience. When the Status
+ *
The current status of the Amazon Q Business web experience. When the Status
* field value is FAILED, the ErrorMessage field contains a
* description of the error that caused the data source connector to fail.
The title for your Amazon Q web experience.
+ *The title for your Amazon Q Business web experience.
* @public */ title?: string; /** - *The subtitle for your Amazon Q web experience.
+ *The subtitle for your Amazon Q Business web experience.
* @public */ subtitle?: string; /** - *The customized welcome message for end users of an Amazon Q web + *
The customized welcome message for end users of an Amazon Q Business web * experience.
* @public */ @@ -3689,7 +3710,14 @@ export interface GetWebExperienceResponse { samplePromptsControlMode?: WebExperienceSamplePromptsControlMode; /** - *The authentication configuration information for your Amazon Q web + *
The Amazon Resource Name (ARN) of the service role attached to your web + * experience.
+ * @public + */ + roleArn?: string; + + /** + *The authentication configuration information for your Amazon Q Business web * experience.
* @public */ @@ -3709,7 +3737,7 @@ export interface GetWebExperienceResponse { */ export interface ListWebExperiencesRequest { /** - *The identifier of the Amazon Q application linked to the listed web + *
The identifier of the Amazon Q Business application linked to the listed web * experiences.
* @public */ @@ -3717,51 +3745,51 @@ export interface ListWebExperiencesRequest { /** *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.
The maximum number of Amazon Q Web Experiences to return.
+ *The maximum number of Amazon Q Business Web Experiences to return.
* @public */ maxResults?: number; } /** - *Provides information for an Amazon Q web experience.
+ *Provides information for an Amazon Q Business web experience.
* @public */ export interface WebExperience { /** - *The identifier of your Amazon Q web experience.
+ *The identifier of your Amazon Q Business web experience.
* @public */ webExperienceId?: string; /** - *The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ createdAt?: Date; /** - *The Unix timestamp when your Amazon Q web experience was updated.
+ *The Unix timestamp when your Amazon Q Business web experience was updated.
* @public */ updatedAt?: Date; /** - *The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully + *
The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully * hosted by Amazon Web Services.
* @public */ defaultEndpoint?: string; /** - *The status of your Amazon Q web experience.
+ *The status of your Amazon Q Business web experience.
* @public */ status?: WebExperienceStatus; @@ -3772,13 +3800,13 @@ export interface WebExperience { */ export interface ListWebExperiencesResponse { /** - *An array of summary information for one or more Amazon Q experiences.
+ *An array of summary information for one or more Amazon Q Business experiences.
* @public */ webExperiences?: WebExperience[]; /** - *If the response is truncated, Amazon Q returns this token, which you can use in a + *
If the response is truncated, Amazon Q Business returns this token, which you can use in a * later request to list the next set of messages.
* @public */ @@ -3790,37 +3818,37 @@ export interface ListWebExperiencesResponse { */ export interface UpdateWebExperienceRequest { /** - *The identifier of the Amazon Q application attached to the web experience.
+ *The identifier of the Amazon Q Business application attached to the web experience.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q web experience.
+ *The identifier of the Amazon Q Business web experience.
* @public */ webExperienceId: string | undefined; /** - *The authentication configuration of the Amazon Q web experience.
+ *The authentication configuration of the Amazon Q Business web experience.
* @public */ authenticationConfiguration?: WebExperienceAuthConfiguration; /** - *The title of the Amazon Q web experience.
+ *The title of the Amazon Q Business web experience.
* @public */ title?: string; /** - *The subtitle of the Amazon Q web experience.
+ *The subtitle of the Amazon Q Business web experience.
* @public */ subtitle?: string; /** - *A customized welcome message for an end user in an Amazon Q web + *
A customized welcome message for an end user in an Amazon Q Business web * experience.
* @public */ @@ -3839,6 +3867,36 @@ export interface UpdateWebExperienceRequest { */ export interface UpdateWebExperienceResponse {} +/** + * @public + * @enum + */ +export const CreatorModeControl = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type CreatorModeControl = (typeof CreatorModeControl)[keyof typeof CreatorModeControl]; + +/** + *The creator mode specific admin controls configured for an Amazon Q Business application. + * Determines whether an end user can generate LLM-only responses when they use the web + * experience.
+ *For more information, see Admin controls and guardrails and Conversation settings.
+ * @public + */ +export interface AppliedCreatorModeConfiguration { + /** + *Information about whether creator mode is enabled or disabled for an Amazon Q Business + * application.
+ * @public + */ + creatorModeControl: CreatorModeControl | undefined; +} + /** *A file directly uploaded into a web experience chat.
* @public @@ -3914,7 +3972,7 @@ export interface DocumentAttribute { } /** - *A document deleted from an Amazon Q data source connector.
+ *A document deleted from an Amazon Q Business data source connector.
* @public */ export interface DeleteDocument { @@ -3930,20 +3988,20 @@ export interface DeleteDocument { */ export interface BatchDeleteDocumentRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q index that contains the documents to + *
The identifier of the Amazon Q Business index that contains the documents to * delete.
* @public */ indexId: string | undefined; /** - *Documents deleted from the Amazon Q index.
+ *Documents deleted from the Amazon Q Business index.
* @public */ documents: DeleteDocument[] | undefined; @@ -3956,14 +4014,14 @@ export interface BatchDeleteDocumentRequest { } /** - *A list of documents that could not be removed from an Amazon Q index. Each entry + *
A list of documents that could not be removed from an Amazon Q Business index. Each entry * contains an error message that indicates why the document couldn't be removed from the * index.
* @public */ export interface FailedDocument { /** - *The identifier of the document that couldn't be removed from the Amazon Q + *
The identifier of the document that couldn't be removed from the Amazon Q Business * index.
* @public */ @@ -3976,7 +4034,7 @@ export interface FailedDocument { error?: ErrorDetail; /** - *The identifier of the Amazon Q data source connector that contains the failed + *
The identifier of the Amazon Q Business data source connector that contains the failed * document.
* @public */ @@ -3988,7 +4046,7 @@ export interface FailedDocument { */ export interface BatchDeleteDocumentResponse { /** - *A list of documents that couldn't be removed from the Amazon Q index. Each entry + *
A list of documents that couldn't be removed from the Amazon Q Business index. Each entry * contains an error message that indicates why the document couldn't be removed from the * index.
* @public @@ -3997,7 +4055,7 @@ export interface BatchDeleteDocumentResponse { } /** - *Information required for Amazon Q to find a specific file in an Amazon S3 + *
Information required for Amazon Q Business to find a specific file in an Amazon S3 * bucket.
* @public */ @@ -4028,8 +4086,8 @@ export namespace DocumentContent { /** *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
+ * using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the
+ * Amazon Q Business endpoint directly using REST, you must base64 encode the contents before
* sending.
A document in an Amazon Q application.
+ *A document in an Amazon Q Business application.
* @public */ export interface Document { @@ -4107,7 +4165,7 @@ export interface Document { id: string | undefined; /** - *Custom attributes to apply to the document for refining Amazon Q web experience + *
Custom attributes to apply to the document for refining Amazon Q Business web experience * responses.
* @public */ @@ -4153,13 +4211,13 @@ export interface Document { */ export interface BatchPutDocumentRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; /** - *The identifier of the Amazon Q index to add the documents to.
+ *The identifier of the Amazon Q Business index to add the documents to.
* @public */ indexId: string | undefined; @@ -4189,7 +4247,7 @@ export interface BatchPutDocumentRequest { */ export interface BatchPutDocumentResponse { /** - *A list of documents that were not added to the Amazon Q index because the + *
A list of documents that were not added to the Amazon Q Business index because the * document failed a validation check. Each document contains an error message that * indicates why the document couldn't be added to the index.
* @public @@ -4204,7 +4262,7 @@ export interface BatchPutDocumentResponse { */ export interface BlockedPhrasesConfiguration { /** - *A list of phrases blocked from a Amazon Q web experience chat.
+ *A list of phrases blocked from a Amazon Q Business web experience chat.
* @public */ blockedPhrases?: string[]; @@ -4218,19 +4276,19 @@ export interface BlockedPhrasesConfiguration { } /** - *Updates a blocked phrases configuration in your Amazon Q application.
+ *Updates a blocked phrases configuration in your Amazon Q Business application.
* @public */ export interface BlockedPhrasesConfigurationUpdate { /** - *Creates or updates a blocked phrases configuration in your Amazon Q + *
Creates or updates a blocked phrases configuration in your Amazon Q Business * application.
* @public */ blockedPhrasesToCreateOrUpdate?: string[]; /** - *Deletes a blocked phrases configuration in your Amazon Q application.
+ *Deletes a blocked phrases configuration in your Amazon Q Business application.
* @public */ blockedPhrasesToDelete?: string[]; @@ -4243,6 +4301,76 @@ export interface BlockedPhrasesConfigurationUpdate { systemMessageOverride?: string; } +/** + * @public + * @enum + */ +export const ChatMode = { + CREATOR_MODE: "CREATOR_MODE", + PLUGIN_MODE: "PLUGIN_MODE", + RETRIEVAL_MODE: "RETRIEVAL_MODE", +} as const; + +/** + * @public + */ +export type ChatMode = (typeof ChatMode)[keyof typeof ChatMode]; + +/** + *Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins, + * and Conversation settings.
+ * @public + */ +export interface PluginConfiguration { + /** + *The identifier of the plugin you want to use.
+ * @public + */ + pluginId: string | undefined; +} + +/** + *Configuration information for Amazon Q Business conversation modes.
+ *For more information, see Admin controls and guardrails and Conversation settings.
+ * @public + */ +export type ChatModeConfiguration = + | ChatModeConfiguration.PluginConfigurationMember + | ChatModeConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace ChatModeConfiguration { + /** + *Configuration information required to invoke chat in PLUGIN_MODE.
Provides information about a text extract in a chat response that can be attributed to * a source document.
@@ -4265,12 +4393,12 @@ export interface TextSegment { } /** - *The documents used to generate an Amazon Q web experience response.
+ *The documents used to generate an Amazon Q Business web experience response.
* @public */ export interface SourceAttribution { /** - *The title of the document which is the source for the Amazon Q generated + *
The title of the document which is the source for the Amazon Q Business generated * response.
* @public */ @@ -4284,20 +4412,20 @@ export interface SourceAttribution { snippet?: string; /** - *The URL of the document which is the source for the Amazon Q generated response. + *
The URL of the document which is the source for the Amazon Q Business generated response. *
* @public */ url?: string; /** - *The number attached to a citation in an Amazon Q generated response.
+ *The number attached to a citation in an Amazon Q Business generated response.
* @public */ citationNumber?: number; /** - *The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ updatedAt?: Date; @@ -4314,7 +4442,7 @@ export interface SourceAttribution { */ export interface ChatSyncOutput { /** - *The identifier of the Amazon Q conversation.
+ *The identifier of the Amazon Q Business conversation.
* @public */ conversationId?: string; @@ -4326,21 +4454,21 @@ export interface ChatSyncOutput { systemMessage?: string; /** - *The identifier of an Amazon Q AI generated message within the + *
The identifier of an Amazon Q Business AI generated message within the * conversation.
* @public */ systemMessageId?: string; /** - *The identifier of an Amazon Q end user text input message within the + *
The identifier of an Amazon Q Business end user text input message within the * conversation.
* @public */ userMessageId?: string; /** - *A request from Amazon Q to the end user for information Amazon Q needs to + *
A request from Amazon Q Business to the end user for information Amazon Q Business needs to * successfully complete a requested plugin action.
* @public */ @@ -4381,7 +4509,7 @@ export class LicenseNotFoundException extends __BaseException { } /** - *A rule for configuring how Amazon Q responds when it encounters a a blocked + *
A rule for configuring how Amazon Q Business responds when it encounters a a blocked * topic. You can configure a custom message to inform your end users that they have asked * about a restricted topic and suggest any next steps they should take.
* @public @@ -4396,7 +4524,7 @@ export interface ContentBlockerRule { } /** - *The identifier of the data source Amazon Q will generate responses from.
+ *The identifier of the data source Amazon Q Business will generate responses from.
* @public */ export interface EligibleDataSource { @@ -4414,13 +4542,13 @@ export interface EligibleDataSource { } /** - *Rules for retrieving content from data sources connected to a Amazon Q + *
Rules for retrieving content from data sources connected to a Amazon Q Business * application for a specific topic control configuration.
* @public */ export interface ContentRetrievalRule { /** - *Specifies data sources in a Amazon Q application to use for content + *
Specifies data sources in a Amazon Q Business application to use for content * generation.
* @public */ @@ -4428,12 +4556,12 @@ export interface ContentRetrievalRule { } /** - *A conversation in an Amazon Q application.
+ *A conversation in an Amazon Q Business application.
* @public */ export interface Conversation { /** - *The identifier of the Amazon Q conversation.
+ *The identifier of the Amazon Q Business conversation.
* @public */ conversationId?: string; @@ -4452,7 +4580,7 @@ export interface Conversation { } /** - *Aliases attached to a user id within an Amazon Q application.
+ *Aliases attached to a user id within an Amazon Q Business application.
* @public */ export interface UserAlias { @@ -4498,7 +4626,7 @@ export interface CreateUserRequest { userAliases?: UserAlias[]; /** - *A token that you provide to identify the request to create your Amazon Q user + *
A token that you provide to identify the request to create your Amazon Q Business user * mapping.
* @public */ @@ -4511,7 +4639,21 @@ export interface CreateUserRequest { export interface CreateUserResponse {} /** - *Maps a batch delete document request to a specific Amazon Q data source connector + *
Configuration information required to invoke chat in CREATOR_MODE.
For more information, see Admin controls and guardrails and Conversation settings.
+ * @public + */ +export interface CreatorModeConfiguration { + /** + *Status information about whether CREATOR_MODE has been enabled or
+ * disabled. The default status is DISABLED.
Maps a batch delete document request to a specific Amazon Q Business data source connector * sync job.
* @public */ @@ -4572,7 +4714,7 @@ export const DataSourceSyncJobStatus = { export type DataSourceSyncJobStatus = (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus]; /** - *Provides information about an Amazon Q data source connector synchronization + *
Provides information about an Amazon Q Business data source connector synchronization * job.
* @public */ @@ -4648,13 +4790,13 @@ export interface DeleteChatControlsConfigurationResponse {} */ export interface DeleteConversationRequest { /** - *The identifier of the Amazon Q web experience conversation being deleted.
+ *The identifier of the Amazon Q Business web experience conversation being deleted.
* @public */ conversationId: string | undefined; /** - *The identifier of the Amazon Q application associated with the + *
The identifier of the Amazon Q Business application associated with the * conversation.
* @public */ @@ -4664,7 +4806,7 @@ export interface DeleteConversationRequest { *The identifier of the user who is deleting the conversation.
* @public */ - userId: string | undefined; + userId?: string; } /** @@ -4756,7 +4898,7 @@ export const DocumentStatus = { export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus]; /** - *The details of a document within an Amazon Q index.
+ *The details of a document within an Amazon Q Business index.
* @public */ export interface DocumentDetails { @@ -4809,8 +4951,8 @@ export interface GetChatControlsConfigurationRequest { /** *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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
+ * pagination token to retrieve the next set of Amazon Q Business chat controls
* configured.
A rule for configuring how Amazon Q responds when it encounters a a blocked + *
A rule for configuring how Amazon Q Business responds when it encounters a a blocked * topic.
* @public */ @@ -4875,7 +5017,7 @@ export namespace RuleConfiguration { } /** - *Rules for retrieving content from data sources connected to a Amazon Q + *
Rules for retrieving content from data sources connected to a Amazon Q Business * application for a specific topic control configuration.
* @public */ @@ -4922,7 +5064,7 @@ export const RuleType = { export type RuleType = (typeof RuleType)[keyof typeof RuleType]; /** - *Guardrail rules for an Amazon Q application. Amazon Q supports only one rule + *
Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule * at a time.
* @public */ @@ -4953,7 +5095,7 @@ export interface Rule { } /** - *The topic specific controls configured for an Amazon Q application.
+ *The topic specific controls configured for an Amazon Q Business application.
* @public */ export interface TopicConfiguration { @@ -4989,7 +5131,7 @@ export interface TopicConfiguration { */ export interface GetChatControlsConfigurationResponse { /** - *The response scope configured for a Amazon Q application. This determines whether + *
The response scope configured for a Amazon Q Business application. This determines whether * your application uses its retrieval augmented generation (RAG) system to generate * answers only from your enterprise data, or also uses the large language models (LLM) * knowledge to respons to end user questions in chat.
@@ -5004,15 +5146,21 @@ export interface GetChatControlsConfigurationResponse { blockedPhrases?: BlockedPhrasesConfiguration; /** - *The topic specific controls configured for a Amazon Q application.
+ *The topic specific controls configured for a Amazon Q Business application.
* @public */ topicConfigurations?: TopicConfiguration[]; + /** + *The configuration details for CREATOR_MODE.
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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
+ * pagination token to retrieve the next set of Amazon Q Business chat controls
* configured.
The Unix timestamp when the Amazon Q application was last updated.
+ *The Unix timestamp when the Amazon Q Business application was last updated.
* @public */ lastUpdatedAt?: Date; @@ -5139,28 +5287,28 @@ export interface GetUserResponse { */ export interface ListConversationsRequest { /** - *The identifier of the Amazon Q application.
+ *The identifier of the Amazon Q Business application.
* @public */ applicationId: string | undefined; /** - *The identifier of the user involved in the Amazon Q web experience conversation. + *
The identifier of the user involved in the Amazon Q Business web experience conversation. *
* @public */ - userId: string | undefined; + userId?: string; /** *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.
The maximum number of Amazon Q conversations to return.
+ *The maximum number of Amazon Q Business conversations to return.
* @public */ maxResults?: number; @@ -5171,14 +5319,14 @@ export interface ListConversationsRequest { */ export interface ListConversationsResponse { /** - *If the response is truncated, Amazon Q returns this token, which you can use in a + *
If the response is truncated, Amazon Q Business returns this token, which you can use in a * later request to list the next set of messages.
* @public */ nextToken?: string; /** - *An array of summary information on the configuration of one or more Amazon Q web + *
An array of summary information on the configuration of one or more Amazon Q Business web * experiences.
* @public */ @@ -5196,20 +5344,20 @@ export interface ListDataSourceSyncJobsRequest { dataSourceId: string | undefined; /** - *The identifier of the Amazon Q application connected to the data source.
+ *The identifier of the Amazon Q Business application connected to the data source.
* @public */ applicationId: string | undefined; /** - *The identifier of the index used with the Amazon Q data source connector.
+ *The identifier of the index used with the Amazon Q Business data source connector.
* @public */ indexId: string | undefined; /** *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
+ * retriever, Amazon Q Business returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of responses.
If the response is truncated, Amazon Q returns this token. You can use this token + *
If the response is truncated, Amazon Q Business returns this token. You can use this token * in any subsequent request to retrieve the next set of jobs.
* @public */ @@ -5283,7 +5431,7 @@ export interface ListDocumentsRequest { /** *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
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to
- * retrieve, Amazon Q returns a pagination token in the response. You can use this
+ * retrieve, Amazon Q Business returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of documents.
If the previous response was incomplete (because there is more data to retrieve), - * Amazon Q returns a pagination token in the response. You can use this pagination + * Amazon Q Business returns a pagination token in the response. You can use this pagination * token to retrieve the next set of groups that are mapped to users.
* @public */ @@ -5376,7 +5524,7 @@ export interface GroupSummary { */ export interface ListGroupsResponse { /** - *If the response is truncated, Amazon Q returns this token that you can use in the + *
If the response is truncated, Amazon Q Business returns this token that you can use in the * subsequent request to retrieve the next set of groups that are mapped to users.
* @public */ @@ -5394,26 +5542,26 @@ export interface ListGroupsResponse { */ export interface ListMessagesRequest { /** - *The identifier of the Amazon Q web experience conversation.
+ *The identifier of the Amazon Q Business web experience conversation.
* @public */ conversationId: string | undefined; /** - *The identifier for the Amazon Q application.
+ *The identifier for the Amazon Q Business application.
* @public */ applicationId: string | undefined; /** - *The identifier of the user involved in the Amazon Q web experience + *
The identifier of the user involved in the Amazon Q Business web experience * conversation.
* @public */ - userId: string | undefined; + userId?: string; /** - *If the number of retrievers returned exceeds maxResults, Amazon Q
+ *
If the number of retrievers returned exceeds maxResults, Amazon Q Business
* returns a next token as a pagination token to retrieve the next set of messages.
A message in an Amazon Q web experience.
+ *A message in an Amazon Q Business web experience.
* @public */ export interface Message { /** - *The identifier of the Amazon Q web experience message.
+ *The identifier of the Amazon Q Business web experience message.
* @public */ messageId?: string; /** - *The content of the Amazon Q web experience message.
+ *The content of the Amazon Q Business web experience message.
* @public */ body?: string; /** - *The timestamp of the first Amazon Q web experience message.
+ *The timestamp of the first Amazon Q Business web experience message.
* @public */ time?: Date; /** - *The type of Amazon Q message, whether HUMAN or AI
+ *
The type of Amazon Q Business message, whether HUMAN or AI
* generated.
A file directly uploaded into an Amazon Q web experience chat.
+ *A file directly uploaded into an Amazon Q Business web experience chat.
* @public */ attachments?: AttachmentOutput[]; /** - *The source documents used to generate Amazon Q web experience message.
+ *The source documents used to generate Amazon Q Business web experience message.
* @public */ sourceAttribution?: SourceAttribution[]; /** - *An output event that Amazon Q returns to an user who wants to perform a plugin + *
An output event that Amazon Q Business returns to an user who wants to perform a plugin * action during a non-streaming chat conversation. It contains information about the * selected action with a list of possible user input fields, some pre-populated by - * Amazon Q.
+ * Amazon Q Business. * @public */ actionReview?: ActionReview; /** - *Performs an Amazon Q plugin action during a non-streaming chat + *
Performs an Amazon Q Business plugin action during a non-streaming chat * conversation.
* @public */ @@ -5510,7 +5658,7 @@ export interface ListMessagesResponse { messages?: Message[]; /** - *If the response is truncated, Amazon Q returns this token, which you can use in a + *
If the response is truncated, Amazon Q Business returns this token, which you can use in a * later request to list the next set of messages.
* @public */ @@ -5522,7 +5670,7 @@ export interface ListMessagesResponse { */ export interface ListTagsForResourceRequest { /** - *The Amazon Resource Name (ARN) of the Amazon Q application or data source to get + *
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get * a list of tags for.
* @public */ @@ -5534,7 +5682,7 @@ export interface ListTagsForResourceRequest { */ export interface ListTagsForResourceResponse { /** - *A list of tags associated with the Amazon Q application or data source.
+ *A list of tags associated with the Amazon Q Business application or data source.
* @public */ tags?: Tag[]; @@ -5623,7 +5771,7 @@ export interface PutFeedbackRequest { *The identifier of the user giving the feedback.
* @public */ - userId: string | undefined; + userId?: string; /** *The identifier of the conversation the feedback is attached to.
@@ -5688,7 +5836,7 @@ export interface MemberUser { /** *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.
+ * Amazon Q Business chat results only from document a user has access to. * @public */ export interface GroupMembers { @@ -5754,7 +5902,7 @@ export interface PutGroupRequest { /** *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.
+ * Amazon Q Business chat results only from document a user has access to. * @public */ groupMembers: GroupMembers | undefined; @@ -5776,7 +5924,7 @@ export interface StartDataSourceSyncJobRequest { dataSourceId: string | undefined; /** - *The identifier of Amazon Q application the data source is connected to.
+ *The identifier of Amazon Q Business application the data source is connected to.
* @public */ applicationId: string | undefined; @@ -5810,14 +5958,14 @@ export interface StopDataSourceSyncJobRequest { dataSourceId: string | undefined; /** - *The identifier of the Amazon Q application that the data source is connected + *
The identifier of the Amazon Q Business application that the data source is connected * to.
* @public */ applicationId: string | undefined; /** - *The identifier of the index used with the Amazon Q data source connector.
+ *The identifier of the index used with the Amazon Q Business data source connector.
* @public */ indexId: string | undefined; @@ -5833,14 +5981,14 @@ export interface StopDataSourceSyncJobResponse {} */ export interface TagResourceRequest { /** - *The Amazon Resource Name (ARN) of the Amazon Q application or data source to + *
The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to * tag.
* @public */ resourceARN: string | undefined; /** - *A list of tag keys to add to the Amazon Q application or data source. If a tag + *
A list of tag keys to add to the Amazon Q Business application or data source. If a tag * already exists, the existing value is replaced with the new value.
* @public */ @@ -5857,14 +6005,14 @@ export interface TagResourceResponse {} */ export interface UntagResourceRequest { /** - *The Amazon Resource Name (ARN) of the Amazon Q application, or data source to + *
The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to * remove the tag from.
* @public */ resourceARN: string | undefined; /** - *A list of tag keys to remove from the Amazon Q application or data source. If a + *
A list of tag keys to remove from the Amazon Q Business application or data source. If a * tag key does not exist on the resource, it is ignored.
* @public */ @@ -5887,7 +6035,7 @@ export interface UpdateChatControlsConfigurationRequest { applicationId: string | undefined; /** - *A token that you provide to identify the request to update a Amazon Q application + *
A token that you provide to identify the request to update a Amazon Q Business application * chat configuration.
* @public */ @@ -5919,6 +6067,12 @@ export interface UpdateChatControlsConfigurationRequest { * @public */ topicConfigurationsToDelete?: TopicConfiguration[]; + + /** + *The configuration details for CREATOR_MODE.
Performs an equals operation on two document attributes or metadata fields.
+ *Performs an equals operation on two document attributes or metadata fields. Supported
+ * for the following document attribute value types: dateValue,
+ * longValue, stringListValue and
+ * stringValue.
Returns true when a document contains all the specified document
- * attributes or metadata fields.
stringListValue.
* @public
*/
containsAll?: DocumentAttribute;
/**
* Returns true when a document contains any of the specified document
- * attributes or metadata fields.
dateValue,
+ * longValue, stringListValue and
+ * stringValue.
* @public
*/
containsAny?: DocumentAttribute;
/**
- * Performs a greater than operation on two document attributes or metadata fields. Use
- * with a document attribute of type Date or Long.
Performs a greater than operation on two document attributes or metadata fields.
+ * Supported for the following document attribute value types: dateValue
+ * and longValue.
Performs a greater or equals than operation on two document attributes or metadata
- * fields. Use with a document attribute of type Date or Long.
- *
dateValue
+ * and longValue.
* @public
*/
greaterThanOrEquals?: DocumentAttribute;
/**
- * Performs a less than operation on two document attributes or metadata fields. Use with
- * a document attribute of type Date or Long.
Performs a less than operation on two document attributes or metadata fields.
+ * Supported for the following document attribute value types: dateValue
+ * and longValue.
Performs a less than or equals operation on two document attributes or metadata
- * fields. Use with a document attribute of type Date or Long.
- *
dateValue
+ * and longValue.
* @public
*/
lessThanOrEquals?: DocumentAttribute;
@@ -6057,7 +6219,7 @@ export interface AttributeFilter {
*/
export interface ChatSyncInput {
/**
- * The identifier of the Amazon Q application linked to the Amazon Q + *
The identifier of the Amazon Q Business application linked to the Amazon Q Business * conversation.
* @public */ @@ -6067,7 +6229,7 @@ export interface ChatSyncInput { *The identifier of the user attached to the chat input.
* @public */ - userId: string | undefined; + userId?: string; /** *The groups that a user associated with the chat input belongs to.
@@ -6089,13 +6251,13 @@ export interface ChatSyncInput { attachments?: AttachmentInput[]; /** - *A request from an end user to perform an Amazon Q plugin action.
+ *A request from an end user to perform an Amazon Q Business plugin action.
* @public */ actionExecution?: ActionExecution; /** - *The identifier of the Amazon Q conversation.
+ *The identifier of the Amazon Q Business conversation.
* @public */ conversationId?: string; @@ -6107,12 +6269,46 @@ export interface ChatSyncInput { parentMessageId?: string; /** - *Enables filtering of Amazon Q web experience responses based on document + *
Enables filtering of Amazon Q Business web experience responses based on document * attributes or metadata fields.
* @public */ attributeFilter?: AttributeFilter; + /** + *The chat modes available in an Amazon Q Business web experience.
+ *
+ * RETRIEVAL_MODE - The default chat mode for an
+ * Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
+ * responses only from data sources connected to an Amazon Q Business
+ * application.
+ * CREATOR_MODE - By selecting this mode, users can choose to
+ * generate responses only from the LLM knowledge, without consulting connected
+ * data sources, for a chat request.
+ * PLUGIN_MODE - By selecting this mode, users can choose to
+ * use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, + * and Conversation settings.
+ * @public + */ + chatMode?: ChatMode; + + /** + *The chat mode configuration for an Amazon Q Business application.
+ * @public + */ + chatModeConfiguration?: ChatModeConfiguration; + /** *A token that you provide to identify a chat request.
* @public diff --git a/clients/client-qbusiness/src/protocols/Aws_restJson1.ts b/clients/client-qbusiness/src/protocols/Aws_restJson1.ts index c7eec479fbe8..b98c5b17b1cc 100644 --- a/clients/client-qbusiness/src/protocols/Aws_restJson1.ts +++ b/clients/client-qbusiness/src/protocols/Aws_restJson1.ts @@ -136,10 +136,12 @@ import { AttributeFilter, BasicAuthConfiguration, BlockedPhrasesConfigurationUpdate, + ChatModeConfiguration, ConflictException, ContentBlockerRule, ContentRetrievalRule, Conversation, + CreatorModeConfiguration, DataSource, DataSourceSyncJob, DataSourceVpcConfiguration, @@ -175,6 +177,7 @@ import { OAuth2ClientCredentialConfiguration, Plugin, PluginAuthConfiguration, + PluginConfiguration, Principal, PrincipalGroup, PrincipalUser, @@ -266,7 +269,7 @@ export const se_ChatSyncCommand = async ( b.p("applicationId", () => input.applicationId!, "{applicationId}", false); const query: any = map({ [_s]: [, ""], - [_uI]: [, __expectNonNull(input[_uI]!, `userId`)], + [_uI]: [, input[_uI]!], [_uG]: [() => input.userGroups !== void 0, () => (input[_uG]! || []).map((_entry) => _entry as any)], }); let body: any; @@ -275,6 +278,8 @@ export const se_ChatSyncCommand = async ( actionExecution: (_) => se_ActionExecution(_, context), attachments: (_) => se_AttachmentsInput(_, context), attributeFilter: (_) => se_AttributeFilter(_, context), + chatMode: [], + chatModeConfiguration: (_) => _json(_), clientToken: [true, (_) => _ ?? generateIdempotencyToken()], conversationId: [], parentMessageId: [], @@ -305,6 +310,7 @@ export const se_CreateApplicationCommand = async ( description: [], displayName: [], encryptionConfiguration: (_) => _json(_), + identityCenterInstanceArn: [], roleArn: [], tags: (_) => _json(_), }) @@ -470,6 +476,7 @@ export const se_CreateWebExperienceCommand = async ( body = JSON.stringify( take(input, { clientToken: [true, (_) => _ ?? generateIdempotencyToken()], + roleArn: [], samplePromptsControlMode: [], subtitle: [], tags: (_) => _json(_), @@ -526,7 +533,7 @@ export const se_DeleteConversationCommand = async ( b.p("conversationId", () => input.conversationId!, "{conversationId}", false); b.p("applicationId", () => input.applicationId!, "{applicationId}", false); const query: any = map({ - [_uI]: [, __expectNonNull(input[_uI]!, `userId`)], + [_uI]: [, input[_uI]!], }); let body: any; b.m("DELETE").h(headers).q(query).b(body); @@ -848,7 +855,7 @@ export const se_ListConversationsCommand = async ( b.bp("/applications/{applicationId}/conversations"); b.p("applicationId", () => input.applicationId!, "{applicationId}", false); const query: any = map({ - [_uI]: [, __expectNonNull(input[_uI]!, `userId`)], + [_uI]: [, input[_uI]!], [_nT]: [, input[_nT]!], [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], }); @@ -984,7 +991,7 @@ export const se_ListMessagesCommand = async ( b.p("conversationId", () => input.conversationId!, "{conversationId}", false); b.p("applicationId", () => input.applicationId!, "{applicationId}", false); const query: any = map({ - [_uI]: [, __expectNonNull(input[_uI]!, `userId`)], + [_uI]: [, input[_uI]!], [_nT]: [, input[_nT]!], [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], }); @@ -1085,7 +1092,7 @@ export const se_PutFeedbackCommand = async ( b.p("conversationId", () => input.conversationId!, "{conversationId}", false); b.p("messageId", () => input.messageId!, "{messageId}", false); const query: any = map({ - [_uI]: [, __expectNonNull(input[_uI]!, `userId`)], + [_uI]: [, input[_uI]!], }); let body: any; body = JSON.stringify( @@ -1250,6 +1257,7 @@ export const se_UpdateChatControlsConfigurationCommand = async ( take(input, { blockedPhrasesConfigurationUpdate: (_) => _json(_), clientToken: [true, (_) => _ ?? generateIdempotencyToken()], + creatorModeConfiguration: (_) => _json(_), responseScope: [], topicConfigurationsToCreateOrUpdate: (_) => _json(_), topicConfigurationsToDelete: (_) => _json(_), @@ -1834,6 +1842,7 @@ export const de_GetApplicationCommand = async ( displayName: __expectString, encryptionConfiguration: _json, error: _json, + identityCenterApplicationArn: __expectString, roleArn: __expectString, status: __expectString, updatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), @@ -1858,6 +1867,7 @@ export const de_GetChatControlsConfigurationCommand = async ( const data: RecordA mapping of field names to the field values in input that an end user provides to\n Amazon Q requests to perform their plugin action.
", + "smithy.api#documentation": "A mapping of field names to the field values in input that an end user provides to\n Amazon Q Business requests to perform their plugin action.
", "smithy.api#required": {} } }, @@ -91,7 +91,7 @@ } }, "traits": { - "smithy.api#documentation": "Performs an Amazon Q plugin action during a non-streaming chat\n conversation.
" + "smithy.api#documentation": "Performs an Amazon Q Business plugin action during a non-streaming chat\n conversation.
" } }, "com.amazonaws.qbusiness#ActionExecutionPayload": { @@ -185,7 +185,7 @@ "payload": { "target": "com.amazonaws.qbusiness#ActionReviewPayload", "traits": { - "smithy.api#documentation": "Field values that an end user needs to provide to Amazon Q for Amazon Q to\n perform the requested plugin action.
" + "smithy.api#documentation": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to\n perform the requested plugin action.
" } }, "payloadFieldNameSeparator": { @@ -196,7 +196,7 @@ } }, "traits": { - "smithy.api#documentation": "An output event that Amazon Q returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q.
" + "smithy.api#documentation": "An output event that Amazon Q Business returns to an user who wants to perform a plugin\n action during a non-streaming chat conversation. It contains information about the\n selected action with a list of possible user input fields, some pre-populated by\n Amazon Q Business.
" } }, "com.amazonaws.qbusiness#ActionReviewPayload": { @@ -238,7 +238,7 @@ "allowedValues": { "target": "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues", "traits": { - "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.
" + "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "required": { @@ -269,7 +269,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q for Amazon Q to perform the requested plugin action.
" + "smithy.api#documentation": "Information about the field values that an end user can use to provide to\n Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "com.amazonaws.qbusiness#ActionReviewPayloadFieldAllowedValues": { @@ -293,36 +293,36 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q application.
" + "smithy.api#documentation": "The name of the Amazon Q Business application.
" } }, "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q application.
" + "smithy.api#documentation": "The identifier for the Amazon Q Business application.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "status": { "target": "com.amazonaws.qbusiness#ApplicationStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q application. The application is ready to use when the\n status is ACTIVE.
The status of the Amazon Q Business application. The application is ready to use when the\n status is ACTIVE.
Summary information for an Amazon Q application.
" + "smithy.api#documentation": "Summary information for an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#ApplicationArn": { @@ -452,6 +452,21 @@ "smithy.api#documentation": "Configuration information about the file upload during chat feature for your\n application.
" } }, + "com.amazonaws.qbusiness#AppliedCreatorModeConfiguration": { + "type": "structure", + "members": { + "creatorModeControl": { + "target": "com.amazonaws.qbusiness#CreatorModeControl", + "traits": { + "smithy.api#documentation": "Information about whether creator mode is enabled or disabled for an Amazon Q Business\n application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The creator mode specific admin controls configured for an Amazon Q Business application.\n Determines whether an end user can generate LLM-only responses when they use the web\n experience.
\nFor more information, see Admin controls and guardrails and Conversation settings.
" + } + }, "com.amazonaws.qbusiness#AttachmentInput": { "type": "structure", "members": { @@ -600,43 +615,43 @@ "equalsTo": { "target": "com.amazonaws.qbusiness#DocumentAttribute", "traits": { - "smithy.api#documentation": "Performs an equals operation on two document attributes or metadata fields.
" + "smithy.api#documentation": "Performs an equals operation on two document attributes or metadata fields. Supported\n for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.
Returns true when a document contains all the specified document\n attributes or metadata fields.
Returns true when a document contains all the specified document\n attributes or metadata fields. Supported for the following document attribute value types:\n stringListValue.
Returns true when a document contains any of the specified document\n attributes or metadata fields.
Returns true when a document contains any of the specified document\n attributes or metadata fields. Supported for the following document attribute value types: dateValue,\n longValue, stringListValue and\n stringValue.
Performs a greater than operation on two document attributes or metadata fields. Use\n with a document attribute of type Date or Long.
Performs a greater than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.
Performs a greater or equals than operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or Long.\n
Performs a greater or equals than operation on two document attributes or metadata\n fields. Supported for the following document attribute value types: dateValue\n and longValue.
Performs a less than operation on two document attributes or metadata fields. Use with\n a document attribute of type Date or Long.
Performs a less than operation on two document attributes or metadata fields.\n Supported for the following document attribute value types: dateValue\n and longValue.
Performs a less than or equals operation on two document attributes or metadata\n fields. Use with a document attribute of type Date or Long.\n
Performs a less than or equals operation on two document attributes or metadata\n fields.Supported for the following document attribute value type: dateValue\n and longValue.
The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.
", + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.
", "smithy.api#required": {} } } @@ -741,7 +756,7 @@ } ], "traits": { - "smithy.api#documentation": "Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", + "smithy.api#documentation": "Asynchronously deletes one or more documents added using the\n BatchPutDocument API from an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents/delete" @@ -754,7 +769,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -762,7 +777,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index that contains the documents to\n delete.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index that contains the documents to\n delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -770,7 +785,7 @@ "documents": { "target": "com.amazonaws.qbusiness#DeleteDocuments", "traits": { - "smithy.api#documentation": "Documents deleted from the Amazon Q index.
", + "smithy.api#documentation": "Documents deleted from the Amazon Q Business index.
", "smithy.api#required": {} } }, @@ -791,7 +806,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "A list of documents that couldn't be removed from the Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "A list of documents that couldn't be removed from the Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" } } }, @@ -831,7 +846,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds one or more documents to an Amazon Q index.
\nYou use this API to:
\ningest your structured and unstructured documents and documents stored in an\n Amazon S3 bucket into an Amazon Q index.
\nadd custom attributes to documents in an Amazon Q index.
\nattach an access control list to the documents added to an Amazon Q\n index.
\nYou can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", + "smithy.api#documentation": "Adds one or more documents to an Amazon Q Business index.
\nYou use this API to:
\ningest your structured and unstructured documents and documents stored in an\n Amazon S3 bucket into an Amazon Q Business index.
\nadd custom attributes to documents in an Amazon Q Business index.
\nattach an access control list to the documents added to an Amazon Q Business\n index.
\nYou can see the progress of the deletion, and any error messages related to the\n process, by using CloudWatch.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/indices/{indexId}/documents" @@ -844,7 +859,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -852,7 +867,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index to add the documents to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index to add the documents to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -887,7 +902,7 @@ "failedDocuments": { "target": "com.amazonaws.qbusiness#FailedDocuments", "traits": { - "smithy.api#documentation": "A list of documents that were not added to the Amazon Q index because the\n document failed a validation check. Each document contains an error message that\n indicates why the document couldn't be added to the index.
" + "smithy.api#documentation": "A list of documents that were not added to the Amazon Q Business index because the\n document failed a validation check. Each document contains an error message that\n indicates why the document couldn't be added to the index.
" } } }, @@ -924,7 +939,7 @@ "blockedPhrases": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "A list of phrases blocked from a Amazon Q web experience chat.
" + "smithy.api#documentation": "A list of phrases blocked from a Amazon Q Business web experience chat.
" } }, "systemMessageOverride": { @@ -944,13 +959,13 @@ "blockedPhrasesToCreateOrUpdate": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "Creates or updates a blocked phrases configuration in your Amazon Q\n application.
" + "smithy.api#documentation": "Creates or updates a blocked phrases configuration in your Amazon Q Business\n application.
" } }, "blockedPhrasesToDelete": { "target": "com.amazonaws.qbusiness#BlockedPhrases", "traits": { - "smithy.api#documentation": "Deletes a blocked phrases configuration in your Amazon Q application.
" + "smithy.api#documentation": "Deletes a blocked phrases configuration in your Amazon Q Business application.
" } }, "systemMessageOverride": { @@ -961,7 +976,7 @@ } }, "traits": { - "smithy.api#documentation": "Updates a blocked phrases configuration in your Amazon Q application.
" + "smithy.api#documentation": "Updates a blocked phrases configuration in your Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#BoostingDurationInSeconds": { @@ -973,6 +988,43 @@ } } }, + "com.amazonaws.qbusiness#ChatMode": { + "type": "enum", + "members": { + "RETRIEVAL_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRIEVAL_MODE" + } + }, + "CREATOR_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATOR_MODE" + } + }, + "PLUGIN_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUGIN_MODE" + } + } + } + }, + "com.amazonaws.qbusiness#ChatModeConfiguration": { + "type": "union", + "members": { + "pluginConfiguration": { + "target": "com.amazonaws.qbusiness#PluginConfiguration", + "traits": { + "smithy.api#documentation": "Configuration information required to invoke chat in PLUGIN_MODE.
Configuration information for Amazon Q Business conversation modes.
\nFor more information, see Admin controls and guardrails and Conversation settings.
" + } + }, "com.amazonaws.qbusiness#ChatSync": { "type": "operation", "input": { @@ -1005,7 +1057,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts or continues a non-streaming Amazon Q conversation.
", + "smithy.api#documentation": "Starts or continues a non-streaming Amazon Q Business conversation.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations?sync", "method": "POST" @@ -1018,7 +1070,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the Amazon Q\n conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business\n conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1027,8 +1079,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user attached to the chat input.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } }, "userGroups": { @@ -1053,13 +1104,13 @@ "actionExecution": { "target": "com.amazonaws.qbusiness#ActionExecution", "traits": { - "smithy.api#documentation": "A request from an end user to perform an Amazon Q plugin action.
" + "smithy.api#documentation": "A request from an end user to perform an Amazon Q Business plugin action.
" } }, "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "parentMessageId": { @@ -1071,7 +1122,19 @@ "attributeFilter": { "target": "com.amazonaws.qbusiness#AttributeFilter", "traits": { - "smithy.api#documentation": "Enables filtering of Amazon Q web experience responses based on document\n attributes or metadata fields.
" + "smithy.api#documentation": "Enables filtering of Amazon Q Business web experience responses based on document\n attributes or metadata fields.
" + } + }, + "chatMode": { + "target": "com.amazonaws.qbusiness#ChatMode", + "traits": { + "smithy.api#documentation": "The chat modes available in an Amazon Q Business web experience.
\n\n RETRIEVAL_MODE - The default chat mode for an\n Amazon Q Business application. When this mode is enabled, Amazon Q Business generates\n responses only from data sources connected to an Amazon Q Business\n application.
\n CREATOR_MODE - By selecting this mode, users can choose to\n generate responses only from the LLM knowledge, without consulting connected\n data sources, for a chat request.
\n PLUGIN_MODE - By selecting this mode, users can choose to\n use plugins in chat.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" + } + }, + "chatModeConfiguration": { + "target": "com.amazonaws.qbusiness#ChatModeConfiguration", + "traits": { + "smithy.api#documentation": "The chat mode configuration for an Amazon Q Business application.
" } }, "clientToken": { @@ -1092,7 +1155,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "systemMessage": { @@ -1104,19 +1167,19 @@ "systemMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "The identifier of an Amazon Q AI generated message within the\n conversation.
" + "smithy.api#documentation": "The identifier of an Amazon Q Business AI generated message within the\n conversation.
" } }, "userMessageId": { "target": "com.amazonaws.qbusiness#MessageId", "traits": { - "smithy.api#documentation": "The identifier of an Amazon Q end user text input message within the\n conversation.
" + "smithy.api#documentation": "The identifier of an Amazon Q Business end user text input message within the\n conversation.
" } }, "actionReview": { "target": "com.amazonaws.qbusiness#ActionReview", "traits": { - "smithy.api#documentation": "A request from Amazon Q to the end user for information Amazon Q needs to\n successfully complete a requested plugin action.
" + "smithy.api#documentation": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to\n successfully complete a requested plugin action.
" } }, "sourceAttributions": { @@ -1187,7 +1250,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.
" + "smithy.api#documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic. You can configure a custom message to inform your end users that they have asked\n about a restricted topic and suggest any next steps they should take.
" } }, "com.amazonaws.qbusiness#ContentRetrievalRule": { @@ -1196,12 +1259,12 @@ "eligibleDataSources": { "target": "com.amazonaws.qbusiness#EligibleDataSources", "traits": { - "smithy.api#documentation": "Specifies data sources in a Amazon Q application to use for content\n generation.
" + "smithy.api#documentation": "Specifies data sources in a Amazon Q Business application to use for content\n generation.
" } } }, "traits": { - "smithy.api#documentation": "Rules for retrieving content from data sources connected to a Amazon Q\n application for a specific topic control configuration.
" + "smithy.api#documentation": "Rules for retrieving content from data sources connected to a Amazon Q Business\n application for a specific topic control configuration.
" } }, "com.amazonaws.qbusiness#ContentType": { @@ -1287,7 +1350,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q conversation.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business conversation.
" } }, "title": { @@ -1304,7 +1367,7 @@ } }, "traits": { - "smithy.api#documentation": "A conversation in an Amazon Q application.
" + "smithy.api#documentation": "A conversation in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#ConversationId": { @@ -1366,7 +1429,7 @@ "kms:DescribeKey", "kms:CreateGrant" ], - "smithy.api#documentation": "Creates an Amazon Q application.
", + "smithy.api#documentation": "Creates an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications", "method": "POST" @@ -1380,7 +1443,7 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "A name for the Amazon Q application.
", + "smithy.api#documentation": "A name for the Amazon Q Business application.
", "smithy.api#required": {} } }, @@ -1391,29 +1454,35 @@ "smithy.api#required": {} } }, + "identityCenterInstanceArn": { + "target": "com.amazonaws.qbusiness#InstanceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either\n creating for—or connecting to—your Amazon Q Business application.
" + } + }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "The identifier of the KMS key that is used to encrypt your data.\n Amazon Q doesn't support asymmetric keys.
" + "smithy.api#documentation": "The identifier of the KMS key that is used to encrypt your data.\n Amazon Q Business doesn't support asymmetric keys.
" } }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.
" + "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business application.\n You can also use tags to help control access to the application. Tag keys and values can\n consist of Unicode letters, digits, white space, and any of the following symbols: _ . :\n / = + - @.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n application.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n application.
", "smithy.api#idempotencyToken": {} } }, @@ -1435,13 +1504,13 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "applicationArn": { "target": "com.amazonaws.qbusiness#ApplicationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" } } }, @@ -1487,7 +1556,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates a data source connector for an Amazon Q application.
\n\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.
Creates a data source connector for an Amazon Q Business application.
\n\n CreateDataSource is a synchronous operation. The operation returns 200 if\n the data source was successfully created. Otherwise, an exception is raised.
The identifier of the Amazon Q application the data source will be attached\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the data source will be attached\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1525,14 +1594,14 @@ "configuration": { "target": "com.amazonaws.qbusiness#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Configuration information to connect to your data source repository. For configuration\n templates for your specific data source, see Supported\n connectors.
", + "smithy.api#documentation": "Configuration information to connect to your data source repository. For configuration\n templates for your specific data source, see Supported\n connectors.
", "smithy.api#required": {} } }, "vpcConfiguration": { "target": "com.amazonaws.qbusiness#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q connectors.
" + "smithy.api#documentation": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect\n to your data source. For more information, see Using\n Amazon VPC with Amazon Q Business connectors.
" } }, "description": { @@ -1551,7 +1620,7 @@ "syncSchedule": { "target": "com.amazonaws.qbusiness#SyncSchedule", "traits": { - "smithy.api#documentation": "Sets the frequency for Amazon Q to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q won't\n periodically update the index.
\nSpecify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
Sets the frequency for Amazon Q Business to check the documents in your data source\n repository and update your index. If you don't set a schedule, Amazon Q Business won't\n periodically update the index.
\nSpecify a cron- format schedule string or an empty string to indicate\n that the index is updated on demand. You can't specify the Schedule\n parameter when the Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Amazon Resource Name (ARN) of a data source in an Amazon Q application.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.\n
" } } }, @@ -1628,7 +1697,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetIndex", "qbusiness:TagResource", "qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Creates an Amazon Q index.
\nTo determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.
Creates an Amazon Q Business index.
\nTo determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.
The identifier of the Amazon Q application using the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1650,14 +1719,14 @@ "target": "com.amazonaws.qbusiness#IndexName", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A name for the Amazon Q index.
", + "smithy.api#documentation": "A name for the Amazon Q Business index.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q index.
" + "smithy.api#documentation": "A description for the Amazon Q Business index.
" } }, "tags": { @@ -1691,13 +1760,13 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q index.
" + "smithy.api#documentation": "The identifier for the Amazon Q Business index.
" } }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q index.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business index.
" } } }, @@ -1743,7 +1812,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates an Amazon Q plugin.
", + "smithy.api#documentation": "Creates an Amazon Q Business plugin.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/plugins" @@ -1799,7 +1868,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n plugin.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n plugin.
", "smithy.api#idempotencyToken": {} } } @@ -1866,7 +1935,7 @@ "qbusiness:GetRetriever", "iam:PassRole" ], - "smithy.api#documentation": "Adds a retriever to your Amazon Q application.
", + "smithy.api#documentation": "Adds a retriever to your Amazon Q Business application.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/retrievers" @@ -1879,7 +1948,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q application.
", + "smithy.api#documentation": "The identifier of your Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1908,13 +1977,13 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q to access the basic\n authentication credentials stored in a Secrets Manager secret.
" + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic\n authentication credentials stored in a Secrets Manager secret.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q\n application retriever.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business\n application retriever.
", "smithy.api#idempotencyToken": {} } }, @@ -2021,7 +2090,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q user\n mapping.
", + "smithy.api#documentation": "A token that you provide to identify the request to create your Amazon Q Business user\n mapping.
", "smithy.api#idempotencyToken": {} } } @@ -2075,7 +2144,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Creates an Amazon Q web experience.
", + "smithy.api#documentation": "Creates an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences", "method": "POST" @@ -2088,7 +2157,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2096,19 +2165,19 @@ "title": { "target": "com.amazonaws.qbusiness#WebExperienceTitle", "traits": { - "smithy.api#documentation": "The title for your Amazon Q web experience.
" + "smithy.api#documentation": "The title for your Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "A subtitle to personalize your Amazon Q web experience.
" + "smithy.api#documentation": "A subtitle to personalize your Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q web\n experience.
" + "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -2117,17 +2186,23 @@ "smithy.api#documentation": "Determines whether sample prompts are enabled in the web experience for an end\n user.
" } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role attached to your web\n experience.
" + } + }, "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.
" + "smithy.api#documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business web\n experience. You can also use tags to help control access to the web experience. Tag keys\n and values can consist of Unicode letters, digits, white space, and any of the following\n symbols: _ . : / = + - @.
" } }, "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token you provide to identify a request to create an Amazon Q web experience.\n
", + "smithy.api#documentation": "A token you provide to identify a request to create an Amazon Q Business web experience.\n
", "smithy.api#idempotencyToken": {} } } @@ -2142,13 +2217,13 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
" } }, "webExperienceArn": { "target": "com.amazonaws.qbusiness#WebExperienceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q web experience.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
" } } }, @@ -2156,48 +2231,80 @@ "smithy.api#output": {} } }, + "com.amazonaws.qbusiness#CreatorModeConfiguration": { + "type": "structure", + "members": { + "creatorModeControl": { + "target": "com.amazonaws.qbusiness#CreatorModeControl", + "traits": { + "smithy.api#documentation": "Status information about whether CREATOR_MODE has been enabled or\n disabled. The default status is DISABLED.
Configuration information required to invoke chat in CREATOR_MODE.
For more information, see Admin controls and guardrails and Conversation settings.
" + } + }, + "com.amazonaws.qbusiness#CreatorModeControl": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.qbusiness#DataSource": { "type": "structure", "members": { "displayName": { "target": "com.amazonaws.qbusiness#DataSourceName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q data source.
" + "smithy.api#documentation": "The name of the Amazon Q Business data source.
" } }, "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q data source.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business data source.
" } }, "type": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The type of the Amazon Q data source.
" + "smithy.api#documentation": "The type of the Amazon Q Business data source.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q data source was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business data source was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q data source was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business data source was last updated.
" } }, "status": { "target": "com.amazonaws.qbusiness#DataSourceStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q data source.
" + "smithy.api#documentation": "The status of the Amazon Q Business data source.
" } } }, "traits": { - "smithy.api#documentation": "A data source in an Amazon Q application.
" + "smithy.api#documentation": "A data source in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#DataSourceArn": { @@ -2213,7 +2320,7 @@ "com.amazonaws.qbusiness#DataSourceConfiguration": { "type": "document", "traits": { - "smithy.api#documentation": "Provides the configuration information for an Amazon Q data source.
" + "smithy.api#documentation": "Provides the configuration information for an Amazon Q Business data source.
" } }, "com.amazonaws.qbusiness#DataSourceId": { @@ -2370,7 +2477,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about an Amazon Q data source connector synchronization\n job.
" + "smithy.api#documentation": "Provides information about an Amazon Q Business data source connector synchronization\n job.
" } }, "com.amazonaws.qbusiness#DataSourceSyncJobMetrics": { @@ -2408,7 +2515,7 @@ } }, "traits": { - "smithy.api#documentation": "Maps a batch delete document request to a specific Amazon Q data source connector\n sync job.
" + "smithy.api#documentation": "Maps a batch delete document request to a specific Amazon Q Business data source connector\n sync job.
" } }, "com.amazonaws.qbusiness#DataSourceSyncJobStatus": { @@ -2487,7 +2594,7 @@ "securityGroupIds": { "target": "com.amazonaws.qbusiness#SecurityGroupIds", "traits": { - "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q to connect to the data source.
", + "smithy.api#documentation": "A list of identifiers of security groups within your Amazon VPC. The security\n groups should enable Amazon Q Business to connect to the data source.
", "smithy.api#required": {} } } @@ -2520,7 +2627,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting DATE type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#DeleteApplication": { @@ -2553,7 +2660,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetApplication", "kms:RetireGrant"], - "smithy.api#documentation": "Deletes an Amazon Q application.
", + "smithy.api#documentation": "Deletes an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "DELETE" @@ -2567,7 +2674,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2610,7 +2717,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes chat controls configured for an existing Amazon Q application.
", + "smithy.api#documentation": "Deletes chat controls configured for an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "DELETE", @@ -2671,7 +2778,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Amazon Q web experience conversation.
", + "smithy.api#documentation": "Deletes an Amazon Q Business web experience conversation.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}", "method": "DELETE" @@ -2685,7 +2792,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience conversation being deleted.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience conversation being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2693,7 +2800,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application associated with the\n conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application associated with the\n conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2702,8 +2809,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user who is deleting the conversation.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } } }, @@ -2748,7 +2854,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetDataSource"], - "smithy.api#documentation": "Deletes an Amazon Q data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.
Deletes an Amazon Q Business data source connector. While the data source is being\n deleted, the Status field returned by a call to the\n DescribeDataSource API is set to DELETING.
The identifier of the Amazon Q application used with the data source\n connector.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application used with the data source\n connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2807,7 +2913,7 @@ } }, "traits": { - "smithy.api#documentation": "A document deleted from an Amazon Q data source connector.
" + "smithy.api#documentation": "A document deleted from an Amazon Q Business data source connector.
" } }, "com.amazonaws.qbusiness#DeleteDocuments": { @@ -2929,7 +3035,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetIndex"], - "smithy.api#documentation": "Deletes an Amazon Q index.
", + "smithy.api#documentation": "Deletes an Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "DELETE" @@ -2943,7 +3049,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application the Amazon Q index is linked\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the Amazon Q Business index is linked\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2951,7 +3057,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2998,7 +3104,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetPlugin"], - "smithy.api#documentation": "Deletes an Amazon Q plugin.
", + "smithy.api#documentation": "Deletes an Amazon Q Business plugin.
", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -3012,7 +3118,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier the application attached to the Amazon Q plugin.
", + "smithy.api#documentation": "The identifier the application attached to the Amazon Q Business plugin.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3067,7 +3173,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetRetriever"], - "smithy.api#documentation": "Deletes the retriever used by an Amazon Q application.
", + "smithy.api#documentation": "Deletes the retriever used by an Amazon Q Business application.
", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -3081,7 +3187,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3204,7 +3310,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:GetWebExperience"], - "smithy.api#documentation": "Deletes an Amazon Q web experience.
", + "smithy.api#documentation": "Deletes an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "DELETE" @@ -3218,7 +3324,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the Amazon Q web\n experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business web\n experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3226,7 +3332,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience being deleted.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience being deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3266,7 +3372,7 @@ "attributes": { "target": "com.amazonaws.qbusiness#DocumentAttributes", "traits": { - "smithy.api#documentation": "Custom attributes to apply to the document for refining Amazon Q web experience\n responses.
" + "smithy.api#documentation": "Custom attributes to apply to the document for refining Amazon Q Business web experience\n responses.
" } }, "content": { @@ -3301,7 +3407,7 @@ } }, "traits": { - "smithy.api#documentation": "A document in an Amazon Q application.
" + "smithy.api#documentation": "A document in an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#DocumentAttribute": { @@ -3355,7 +3461,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting supported Amazon Q document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q prioritizes generating responses from content that matches the boosted\n document attributes.
\nFor STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting supported Amazon Q Business document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q Business prioritizes generating responses from content that matches the boosted\n document attributes.
\nFor STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel": { @@ -3413,7 +3519,7 @@ "key": { "target": "com.amazonaws.qbusiness#DocumentAttributeKey", "traits": { - "smithy.api#documentation": "The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Q currently doesn't support _document_body as an attribute\n key used for the condition.
The identifier of the document attribute used for the condition.
\nFor example, 'Source_URI' could be an identifier for the attribute or metadata field\n that contains source URIs associated with the documents.
\nAmazon Q Business currently doesn't support _document_body as an attribute\n key used for the condition.
The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q. You use this with \n DocumentAttributeTarget\n to apply the condition.
For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.
\nAmazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q then will map your newly\n created metadata field to your index field.
The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q Business. You use this with \n DocumentAttributeTarget\n to apply the condition.
For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.
\nAmazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q Business then will map your newly\n created metadata field to your index field.
The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q.
\nFor example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q\n will then map your newly created document attribute to your index field.
You can also use this with \n DocumentAttributeCondition\n .
The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q Business.
\nFor example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.
Amazon Q Business can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q Business\n will then map your newly created document attribute to your index field.
You can also use this with \n DocumentAttributeCondition\n .
The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the\n Amazon Q endpoint directly using REST, you must base64 encode the contents before\n sending.
The contents of the document. Documents passed to the blob parameter must\n be base64 encoded. Your code might not need to encode the document file bytes if you're\n using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the\n Amazon Q Business endpoint directly using REST, you must base64 encode the contents before\n sending.
The details of a document within an Amazon Q index.
" + "smithy.api#documentation": "The details of a document within an Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#DocumentEnrichmentConditionOperator": { @@ -3717,7 +3823,7 @@ "inlineConfigurations": { "target": "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations", "traits": { - "smithy.api#documentation": "Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q.
" + "smithy.api#documentation": "Configuration information to alter document attributes or metadata fields and content\n when ingesting documents into Amazon Q Business.
" } }, "preExtractionHookConfiguration": { @@ -3823,7 +3929,7 @@ } }, "traits": { - "smithy.api#documentation": "The identifier of the data source Amazon Q will generate responses from.
" + "smithy.api#documentation": "The identifier of the data source Amazon Q Business will generate responses from.
" } }, "com.amazonaws.qbusiness#EligibleDataSources": { @@ -3843,12 +3949,12 @@ "kmsKeyId": { "target": "com.amazonaws.qbusiness#KmsKeyId", "traits": { - "smithy.api#documentation": "The identifier of the KMS key. Amazon Q doesn't support asymmetric\n keys.
" + "smithy.api#documentation": "The identifier of the KMS key. Amazon Q Business doesn't support asymmetric\n keys.
" } } }, "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q. Amazon Q doesn't support asymmetric keys.
" + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt data indexed by\n Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
" } }, "com.amazonaws.qbusiness#ErrorCode": { @@ -4039,7 +4145,7 @@ "http": ["h2", "http/1.1"], "eventStreamHttp": ["h2"] }, - "smithy.api#documentation": "Amazon Q is in preview release and is subject to change.
\nThis is the Amazon Q (for business use) API Reference.\n Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that\n you can deploy within your organization. Amazon Q enhances employee productivity by\n supporting key tasks such as question-answering, knowledge discovery, writing email\n messages, summarizing text, drafting document outlines, and brainstorming ideas. Users\n ask questions of Amazon Q and get answers that are presented in a conversational\n manner. For an introduction to the service, see the \n Amazon Q (for business use) Developer\n Guide\n .
\nFor an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q in the\n Amazon Q (for business use) Developer Guide.
\nYou can use the following AWS SDKs to access Amazon Q APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q\n API:
\n\n \n Setting up for\n Amazon Q\n \n
\n\n \n Amazon Q CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nAmazon Q is in preview release and is subject to change.
\nThis is the Amazon Q Business API Reference. Amazon Q Business is a fully\n managed, generative-AI powered enterprise chat assistant that you can deploy within your\n organization. Amazon Q Business enhances employee productivity by supporting key tasks such\n as question-answering, knowledge discovery, writing email messages, summarizing text,\n drafting document outlines, and brainstorming ideas. Users ask questions of\n Amazon Q Business and get answers that are presented in a conversational manner. For an\n introduction to the service, see the \n Amazon Q Business User Guide\n .
\nFor an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
\nFor information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q Business in the\n Amazon Q Business User Guide.
\nYou can use the following AWS SDKs to access Amazon Q Business APIs:
\n\n AWS SDK for C++\n
\n\n AWS SDK for Go\n
\n\n AWS SDK for Java\n
\n\n AWS SDK for .NET\n
\n\n AWS SDK for Ruby\n
\nThe following resources provide additional information about using the Amazon Q Business\n API:
\n\n \n Setting up for\n Amazon Q Business\n \n
\n\n \n Amazon Q Business CLI Reference\n \n
\n\n \n Amazon Web Services General Reference\n \n
\nThe identifier of the document that couldn't be removed from the Amazon Q\n index.
" + "smithy.api#documentation": "The identifier of the document that couldn't be removed from the Amazon Q Business\n index.
" } }, "error": { @@ -4427,12 +4533,12 @@ "dataSourceId": { "target": "com.amazonaws.qbusiness#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q data source connector that contains the failed\n document.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business data source connector that contains the failed\n document.
" } } }, "traits": { - "smithy.api#documentation": "A list of documents that could not be removed from an Amazon Q index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" + "smithy.api#documentation": "A list of documents that could not be removed from an Amazon Q Business index. Each entry\n contains an error message that indicates why the document couldn't be removed from the\n index.
" } }, "com.amazonaws.qbusiness#FailedDocuments": { @@ -4468,7 +4574,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Gets information about an existing Amazon Q application.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "GET" @@ -4482,7 +4588,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4498,19 +4604,25 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q application.
" + "smithy.api#documentation": "The name of the Amazon Q Business application.
" } }, "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "applicationArn": { "target": "com.amazonaws.qbusiness#ApplicationArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" + } + }, + "identityCenterApplicationArn": { + "target": "com.amazonaws.qbusiness#IdcApplicationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to\n your Amazon Q Business application.
" } }, "roleArn": { @@ -4522,32 +4634,32 @@ "status": { "target": "com.amazonaws.qbusiness#ApplicationStatus", "traits": { - "smithy.api#documentation": "The status of the Amazon Q application.
" + "smithy.api#documentation": "The status of the Amazon Q Business application.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.qbusiness#EncryptionConfiguration", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q doesn't support\n asymmetric keys.
" + "smithy.api#documentation": "The identifier of the Amazon Web Services\n KMS key that is used to encrypt your data. Amazon Q Business doesn't support\n asymmetric keys.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "error": { @@ -4595,7 +4707,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about an chat controls configured for an existing Amazon Q\n application.
", + "smithy.api#documentation": "Gets information about an chat controls configured for an existing Amazon Q Business\n application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "GET", @@ -4631,7 +4743,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.
The response scope configured for a Amazon Q application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.
" + "smithy.api#documentation": "The response scope configured for a Amazon Q Business application. This determines whether\n your application uses its retrieval augmented generation (RAG) system to generate\n answers only from your enterprise data, or also uses the large language models (LLM)\n knowledge to respons to end user questions in chat.
" } }, "blockedPhrases": { @@ -4658,13 +4770,19 @@ "topicConfigurations": { "target": "com.amazonaws.qbusiness#TopicConfigurations", "traits": { - "smithy.api#documentation": "The topic specific controls configured for a Amazon Q application.
" + "smithy.api#documentation": "The topic specific controls configured for a Amazon Q Business application.
" + } + }, + "creatorModeConfiguration": { + "target": "com.amazonaws.qbusiness#AppliedCreatorModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for CREATOR_MODE.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q chat controls\n configured.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business chat controls\n configured.
Gets information about an existing Amazon Q data source connector.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business data source connector.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "method": "GET" @@ -4713,7 +4831,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4745,7 +4863,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
" } }, "indexId": { @@ -4817,7 +4935,7 @@ "syncSchedule": { "target": "com.amazonaws.qbusiness#SyncSchedule", "traits": { - "smithy.api#documentation": "The schedule for Amazon Q to update the index.
" + "smithy.api#documentation": "The schedule for Amazon Q Business to update the index.
" } }, "roleArn": { @@ -4964,7 +5082,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Gets information about an existing Amazon Q index.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "GET" @@ -4978,7 +5096,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4986,7 +5104,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index you want information on.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index you want information on.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5002,25 +5120,25 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application associated with the index.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application associated with the index.
" } }, "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
" } }, "displayName": { "target": "com.amazonaws.qbusiness#IndexName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q index.
" + "smithy.api#documentation": "The name of the Amazon Q Business index.
" } }, "indexArn": { "target": "com.amazonaws.qbusiness#IndexArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q index.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business index.
" } }, "status": { @@ -5032,25 +5150,25 @@ "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "The description for the Amazon Q index.
" + "smithy.api#documentation": "The description for the Amazon Q Business index.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q index was created.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business index was created.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q index was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business index was last updated.
" } }, "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "The storage capacity units chosen for your Amazon Q index.
" + "smithy.api#documentation": "The storage capacity units chosen for your Amazon Q Business index.
" } }, "documentAttributeConfigurations": { @@ -5104,7 +5222,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Gets information about an existing Amazon Q plugin.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business plugin.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -5228,7 +5346,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Gets information about an existing retriever used by an Amazon Q\n application.
", + "smithy.api#documentation": "Gets information about an existing retriever used by an Amazon Q Business\n application.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -5242,7 +5360,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5266,7 +5384,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
" } }, "retrieverId": { @@ -5427,7 +5545,7 @@ ], "traits": { "aws.iam#requiredActions": ["qbusiness:ListTagsForResource"], - "smithy.api#documentation": "Gets information about an existing Amazon Q web experience.
", + "smithy.api#documentation": "Gets information about an existing Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "GET" @@ -5441,7 +5559,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5449,7 +5567,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5465,31 +5583,31 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the web experience.
" } }, "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
" } }, "webExperienceArn": { "target": "com.amazonaws.qbusiness#WebExperienceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q web experience and required resources.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the\n Amazon Q Business web experience and required resources.
" } }, "defaultEndpoint": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "The endpoint of your Amazon Q web experience.
" + "smithy.api#documentation": "The endpoint of your Amazon Q Business web experience.
" } }, "status": { "target": "com.amazonaws.qbusiness#WebExperienceStatus", "traits": { - "smithy.api#documentation": "The current status of the Amazon Q web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.
The current status of the Amazon Q Business web experience. When the Status\n field value is FAILED, the ErrorMessage field contains a\n description of the error that caused the data source connector to fail.
The title for your Amazon Q web experience.
" + "smithy.api#documentation": "The title for your Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "The subtitle for your Amazon Q web experience.
" + "smithy.api#documentation": "The subtitle for your Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q web\n experience.
" + "smithy.api#documentation": "The customized welcome message for end users of an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -5528,10 +5646,16 @@ "smithy.api#documentation": "Determines whether sample prompts are enabled in the web experience for an end\n user.
" } }, + "roleArn": { + "target": "com.amazonaws.qbusiness#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role attached to your web\n experience.
" + } + }, "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { - "smithy.api#documentation": "The authentication configuration information for your Amazon Q web\n experience.
" + "smithy.api#documentation": "The authentication configuration information for your Amazon Q Business web\n experience.
" } }, "error": { @@ -5563,7 +5687,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of users or sub groups that belong to a group. This is for generating\n Amazon Q chat results only from document a user has access to.
" + "smithy.api#documentation": "A list of users or sub groups that belong to a group. This is for generating\n Amazon Q Business chat results only from document a user has access to.
" } }, "com.amazonaws.qbusiness#GroupName": { @@ -5623,7 +5747,7 @@ "lastUpdatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "errorDetail": { @@ -5669,7 +5793,7 @@ "invocationCondition": { "target": "com.amazonaws.qbusiness#DocumentAttributeCondition", "traits": { - "smithy.api#documentation": "The condition used for when a Lambda function should be invoked.
\nFor example, you can specify a condition that if there are empty date-time values,\n then Amazon Q should invoke a function that inserts the current date-time.
" + "smithy.api#documentation": "The condition used for when a Lambda function should be invoked.
\nFor example, you can specify a condition that if there are empty date-time values,\n then Amazon Q Business should invoke a function that inserts the current date-time.
" } }, "lambdaArn": { @@ -5692,7 +5816,17 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q.
\nYou can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.
\nIf you want to apply advanced alterations on the Amazon Q structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.
\nYou can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" + "smithy.api#documentation": "Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q Business.
\nYou can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.
\nIf you want to apply advanced alterations on the Amazon Q Business structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.
\nYou can only invoke one Lambda function. However, this function can invoke\n other functions it requires.
\nFor more information, see Custom document enrichment.
" + } + }, + "com.amazonaws.qbusiness#IdcApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" } }, "com.amazonaws.qbusiness#Index": { @@ -5730,7 +5864,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information for your Amazon Q index.
" + "smithy.api#documentation": "Summary information for your Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#IndexArn": { @@ -5749,7 +5883,7 @@ "units": { "target": "com.amazonaws.qbusiness#IndexCapacityInteger", "traits": { - "smithy.api#documentation": "The number of storage units configured for an Amazon Q index.
" + "smithy.api#documentation": "The number of storage units configured for an Amazon Q Business index.
" } } }, @@ -5909,7 +6043,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q.
\nTo apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .
For more information, see Custom document enrichment.
" + "smithy.api#documentation": "Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q Business.
\nTo apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .
For more information, see Custom document enrichment.
" } }, "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations": { @@ -5924,6 +6058,16 @@ } } }, + "com.amazonaws.qbusiness#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 1224 + }, + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + } + }, "com.amazonaws.qbusiness#Integer": { "type": "integer" }, @@ -5938,7 +6082,7 @@ } }, "traits": { - "smithy.api#documentation": "An issue occurred with the internal server used for your Amazon Q service. Wait\n some minutes and try again, or contact Support for help.
", + "smithy.api#documentation": "An issue occurred with the internal server used for your Amazon Q Business service. Wait\n some minutes and try again, or contact Support for help.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -6027,7 +6171,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Amazon Q applications.
", + "smithy.api#documentation": "Lists Amazon Q Business applications.
", "smithy.api#http": { "uri": "/applications", "method": "GET" @@ -6047,14 +6191,14 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q applications.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business applications.
The maximum number of Amazon Q applications to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business applications to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -6069,13 +6213,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of applications.
" } }, "applications": { "target": "com.amazonaws.qbusiness#Applications", "traits": { - "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q\n applications.
" + "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q Business\n applications.
" } } }, @@ -6112,7 +6256,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists one or more Amazon Q conversations.
", + "smithy.api#documentation": "Lists one or more Amazon Q Business conversations.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations", "method": "GET" @@ -6132,7 +6276,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6140,22 +6284,21 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "The identifier of the user involved in the Amazon Q web experience conversation.\n
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the user involved in the Amazon Q Business web experience conversation.\n
", + "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.
The maximum number of Amazon Q conversations to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business conversations to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -6170,13 +6313,13 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } }, "conversations": { "target": "com.amazonaws.qbusiness#Conversations", "traits": { - "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q web\n experiences.
" + "smithy.api#documentation": "An array of summary information on the configuration of one or more Amazon Q Business web\n experiences.
" } } }, @@ -6210,7 +6353,7 @@ } ], "traits": { - "smithy.api#documentation": "Get information about an Amazon Q data source connector synchronization.
", + "smithy.api#documentation": "Get information about an Amazon Q Business data source connector synchronization.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs", "method": "GET" @@ -6238,7 +6381,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the data source.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the data source.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6246,7 +6389,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "smithy.api#documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6254,7 +6397,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.
If the maxResults response was incpmplete because there is more data to\n retriever, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of responses.
If the response is truncated, Amazon Q returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in any subsequent request to retrieve the next set of jobs.
" } } }, @@ -6337,7 +6480,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Q data source connectors that you have created.
", + "smithy.api#documentation": "Lists the Amazon Q Business data source connectors that you have created.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources", "method": "GET" @@ -6357,7 +6500,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the data source\n connectors.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the data source\n connectors.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6373,7 +6516,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q data source\n connectors.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business data source\n connectors.
If the response is truncated, Amazon Q returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token\n in a subsequent request to retrieve the next set of data source connectors.
" } } }, @@ -6478,7 +6621,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of documents.
If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.
", + "smithy.api#documentation": "If the previous response was incomplete (because there is more data to retrieve),\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of groups that are mapped to users.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6616,7 +6759,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of groups that are mapped to users.
" } }, "items": { @@ -6656,7 +6799,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Q indices you have created.
", + "smithy.api#documentation": "Lists the Amazon Q Business indices you have created.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices", "method": "GET" @@ -6676,7 +6819,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6684,7 +6827,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q indices.
", + "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to retrieve,\n Amazon Q Business returns a pagination token in the response. You can use this pagination\n token to retrieve the next set of Amazon Q Business indices.
", "smithy.api#httpQuery": "nextToken" } }, @@ -6706,7 +6849,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the\n subsequent request to retrieve the next set of indexes.
" } }, "indices": { @@ -6749,7 +6892,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of messages associated with an Amazon Q web experience.
", + "smithy.api#documentation": "Gets a list of messages associated with an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}", "method": "GET" @@ -6769,7 +6912,7 @@ "conversationId": { "target": "com.amazonaws.qbusiness#ConversationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience conversation.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6777,7 +6920,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q application.
", + "smithy.api#documentation": "The identifier for the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6785,15 +6928,14 @@ "userId": { "target": "com.amazonaws.qbusiness#UserId", "traits": { - "smithy.api#documentation": "The identifier of the user involved in the Amazon Q web experience\n conversation.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the user involved in the Amazon Q Business web experience\n conversation.
", + "smithy.api#httpQuery": "userId" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of messages.
If the number of retrievers returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of messages.
If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } } }, @@ -6855,7 +6997,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists configured Amazon Q plugins.
", + "smithy.api#documentation": "Lists configured Amazon Q Business plugins.
", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/plugins" @@ -6883,7 +7025,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of plugins.
Lists the retriever used by an Amazon Q application.
", + "smithy.api#documentation": "Lists the retriever used by an Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/retrievers", "method": "GET" @@ -6965,7 +7107,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6973,7 +7115,7 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the number of retrievers returned exceeds maxResults, Amazon Q\n returns a next token as a pagination token to retrieve the next set of\n retrievers.
If the number of retrievers returned exceeds maxResults, Amazon Q Business\n returns a next token as a pagination token to retrieve the next set of\n retrievers.
If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of retrievers.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of retrievers.
" } } }, @@ -7035,7 +7177,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of tags associated with a specified resource. Amazon Q applications\n and data sources can have tags associated with them.
", + "smithy.api#documentation": "Gets a list of tags associated with a specified resource. Amazon Q Business applications\n and data sources can have tags associated with them.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "GET" @@ -7049,7 +7191,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to get\n a list of tags for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get\n a list of tags for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7065,7 +7207,7 @@ "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { - "smithy.api#documentation": "A list of tags associated with the Amazon Q application or data source.
" + "smithy.api#documentation": "A list of tags associated with the Amazon Q Business application or data source.
" } } }, @@ -7099,7 +7241,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists one or more Amazon Q Web Experiences.
", + "smithy.api#documentation": "Lists one or more Amazon Q Business Web Experiences.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences", "method": "GET" @@ -7119,7 +7261,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application linked to the listed web\n experiences.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application linked to the listed web\n experiences.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7127,14 +7269,14 @@ "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults response was incomplete because there is more data to\n retrieve, Amazon Q Business returns a pagination token in the response. You can use this\n pagination token to retrieve the next set of Amazon Q Business conversations.
The maximum number of Amazon Q Web Experiences to return.
", + "smithy.api#documentation": "The maximum number of Amazon Q Business Web Experiences to return.
", "smithy.api#httpQuery": "maxResults" } } @@ -7149,13 +7291,13 @@ "webExperiences": { "target": "com.amazonaws.qbusiness#WebExperiences", "traits": { - "smithy.api#documentation": "An array of summary information for one or more Amazon Q experiences.
" + "smithy.api#documentation": "An array of summary information for one or more Amazon Q Business experiences.
" } }, "nextToken": { "target": "com.amazonaws.qbusiness#NextToken", "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a\n later request to list the next set of messages.
" + "smithy.api#documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a\n later request to list the next set of messages.
" } } }, @@ -7380,37 +7522,37 @@ "messageId": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience message.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience message.
" } }, "body": { "target": "com.amazonaws.qbusiness#MessageBody", "traits": { - "smithy.api#documentation": "The content of the Amazon Q web experience message.
" + "smithy.api#documentation": "The content of the Amazon Q Business web experience message.
" } }, "time": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp of the first Amazon Q web experience message.
" + "smithy.api#documentation": "The timestamp of the first Amazon Q Business web experience message.
" } }, "type": { "target": "com.amazonaws.qbusiness#MessageType", "traits": { - "smithy.api#documentation": "The type of Amazon Q message, whether HUMAN or AI\n generated.
The type of Amazon Q Business message, whether HUMAN or AI\n generated.
A file directly uploaded into an Amazon Q web experience chat.
" + "smithy.api#documentation": "A file directly uploaded into an Amazon Q Business web experience chat.
" } }, "sourceAttribution": { "target": "com.amazonaws.qbusiness#SourceAttributions", "traits": { - "smithy.api#documentation": "The source documents used to generate Amazon Q web experience message.
" + "smithy.api#documentation": "The source documents used to generate Amazon Q Business web experience message.
" } }, "actionReview": { @@ -7421,7 +7563,7 @@ } }, "traits": { - "smithy.api#documentation": "A message in an Amazon Q web experience.
" + "smithy.api#documentation": "A message in an Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#MessageBody": { @@ -7617,19 +7759,19 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier for the Amazon Q index.
", + "smithy.api#documentation": "The identifier for the Amazon Q Business index.
", "smithy.api#required": {} } }, "boostingOverride": { "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingOverrideMap", "traits": { - "smithy.api#documentation": "Overrides the default boosts applied by Amazon Q to supported document attribute\n data types.
" + "smithy.api#documentation": "Overrides the default boosts applied by Amazon Q Business to supported document attribute\n data types.
" } } }, "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Q index.
" + "smithy.api#documentation": "Configuration information for an Amazon Q Business index.
" } }, "com.amazonaws.qbusiness#NextToken": { @@ -7659,7 +7801,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting NUMBER type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#NumberAttributeBoostingType": { @@ -7692,7 +7834,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.
", + "smithy.api#documentation": "The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0\n authentication credentials stored in a Secrets Manager secret.
", "smithy.api#required": {} } } @@ -7748,7 +7890,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about an Amazon Q plugin and its configuration.
" + "smithy.api#documentation": "Information about an Amazon Q Business plugin and its configuration.
" } }, "com.amazonaws.qbusiness#PluginArn": { @@ -7778,7 +7920,22 @@ } }, "traits": { - "smithy.api#documentation": "Authentication configuration information for an Amazon Q plugin.
" + "smithy.api#documentation": "Authentication configuration information for an Amazon Q Business plugin.
" + } + }, + "com.amazonaws.qbusiness#PluginConfiguration": { + "type": "structure", + "members": { + "pluginId": { + "target": "com.amazonaws.qbusiness#PluginId", + "traits": { + "smithy.api#documentation": "The identifier of the plugin you want to use.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins,\n and Conversation settings.
" } }, "com.amazonaws.qbusiness#PluginId": { @@ -7901,7 +8058,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides user and group information used for filtering documents to use for generating\n Amazon Q conversation responses.
" + "smithy.api#documentation": "Provides user and group information used for filtering documents to use for generating\n Amazon Q Business conversation responses.
" } }, "com.amazonaws.qbusiness#PrincipalGroup": { @@ -7990,7 +8147,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables your end user to to provide feedback on their Amazon Q generated chat\n responses.
", + "smithy.api#documentation": "Enables your end user to provide feedback on their Amazon Q Business generated chat\n responses.
", "smithy.api#http": { "uri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback", "method": "POST" @@ -8012,8 +8169,7 @@ "target": "com.amazonaws.qbusiness#UserId", "traits": { "smithy.api#documentation": "The identifier of the user giving the feedback.
", - "smithy.api#httpQuery": "userId", - "smithy.api#required": {} + "smithy.api#httpQuery": "userId" } }, "conversationId": { @@ -8081,7 +8237,7 @@ } ], "traits": { - "smithy.api#documentation": "Create, or updates, a mapping of users—who have access to a document—to\n groups.
\nYou can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q chat results.
", + "smithy.api#documentation": "Create, or updates, a mapping of users—who have access to a document—to\n groups.
\nYou can also map sub groups to groups. For example, the group \"Company Intellectual\n Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups\n include their own list of users or people who work in these teams. Only users who work\n in research and engineering, and therefore belong in the intellectual property group,\n can see top-secret company documents in their Amazon Q Business chat results.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/indices/{indexId}/groups" @@ -8217,13 +8373,13 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application using the retriever.
" + "smithy.api#documentation": "The identifier of the Amazon Q Business application using the retriever.
" } }, "retrieverId": { "target": "com.amazonaws.qbusiness#RetrieverId", "traits": { - "smithy.api#documentation": "The identifier of the retriever used by your Amazon Q application.
" + "smithy.api#documentation": "The identifier of the retriever used by your Amazon Q Business application.
" } }, "type": { @@ -8246,7 +8402,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information for the retriever used for your Amazon Q application.
" + "smithy.api#documentation": "Summary information for the retriever used for your Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#RetrieverArn": { @@ -8265,18 +8421,18 @@ "nativeIndexConfiguration": { "target": "com.amazonaws.qbusiness#NativeIndexConfiguration", "traits": { - "smithy.api#documentation": "Provides information on how a Amazon Q index used as a retriever for your\n Amazon Q application is configured.
" + "smithy.api#documentation": "Provides information on how a Amazon Q Business index used as a retriever for your\n Amazon Q Business application is configured.
" } }, "kendraIndexConfiguration": { "target": "com.amazonaws.qbusiness#KendraIndexConfiguration", "traits": { - "smithy.api#documentation": "Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q application is configured.
" + "smithy.api#documentation": "Provides information on how the Amazon Kendra index used as a retriever for your\n Amazon Q Business application is configured.
" } } }, "traits": { - "smithy.api#documentation": "Provides information on how the retriever used for your Amazon Q application is\n configured.
" + "smithy.api#documentation": "Provides information on how the retriever used for your Amazon Q Business application is\n configured.
" } }, "com.amazonaws.qbusiness#RetrieverId": { @@ -8416,7 +8572,7 @@ } }, "traits": { - "smithy.api#documentation": "Guardrail rules for an Amazon Q application. Amazon Q supports only one rule\n at a time.
" + "smithy.api#documentation": "Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule\n at a time.
" } }, "com.amazonaws.qbusiness#RuleConfiguration": { @@ -8425,7 +8581,7 @@ "contentBlockerRule": { "target": "com.amazonaws.qbusiness#ContentBlockerRule", "traits": { - "smithy.api#documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked\n topic.
" + "smithy.api#documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked\n topic.
" } }, "contentRetrievalRule": { @@ -8483,7 +8639,7 @@ } }, "traits": { - "smithy.api#documentation": "Information required for Amazon Q to find a specific file in an Amazon S3\n bucket.
" + "smithy.api#documentation": "Information required for Amazon Q Business to find a specific file in an Amazon S3\n bucket.
" } }, "com.amazonaws.qbusiness#S3BucketName": { @@ -8527,7 +8683,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q web experience, containing the relevant\n Amazon Q permissions for conversing with Amazon Q.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when\n they authenticate into their Amazon Q Business web experience, containing the relevant\n Amazon Q Business permissions for conversing with Amazon Q Business.
", "smithy.api#required": {} } }, @@ -8546,7 +8702,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q needs to deploy a Amazon Q web experience.
" + "smithy.api#documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information\n Amazon Q Business needs to deploy a Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#SamlMetadataXML": { @@ -8617,7 +8773,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded the set limits for your Amazon Q service.
", + "smithy.api#documentation": "You have exceeded the set limits for your Amazon Q Business service.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -8628,7 +8784,7 @@ "title": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The title of the document which is the source for the Amazon Q generated\n response.
" + "smithy.api#documentation": "The title of the document which is the source for the Amazon Q Business generated\n response.
" } }, "snippet": { @@ -8640,19 +8796,19 @@ "url": { "target": "com.amazonaws.qbusiness#String", "traits": { - "smithy.api#documentation": "The URL of the document which is the source for the Amazon Q generated response.\n
" + "smithy.api#documentation": "The URL of the document which is the source for the Amazon Q Business generated response.\n
" } }, "citationNumber": { "target": "com.amazonaws.qbusiness#Integer", "traits": { - "smithy.api#documentation": "The number attached to a citation in an Amazon Q generated response.
" + "smithy.api#documentation": "The number attached to a citation in an Amazon Q Business generated response.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "textMessageSegments": { @@ -8663,7 +8819,7 @@ } }, "traits": { - "smithy.api#documentation": "The documents used to generate an Amazon Q web experience response.
" + "smithy.api#documentation": "The documents used to generate an Amazon Q Business web experience response.
" } }, "com.amazonaws.qbusiness#SourceAttributions": { @@ -8707,7 +8863,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q returns a ConflictException.
Starts a data source connector synchronization job. If a synchronization job is\n already in progress, Amazon Q Business returns a ConflictException.
The identifier of Amazon Q application the data source is connected to.
", + "smithy.api#documentation": "The identifier of Amazon Q Business application the data source is connected to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8803,7 +8959,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops an Amazon Q data source connector synchronization job already in\n progress.
", + "smithy.api#documentation": "Stops an Amazon Q Business data source connector synchronization job already in\n progress.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync", "method": "POST" @@ -8824,7 +8980,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application that the data source is connected\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application that the data source is connected\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8832,7 +8988,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "smithy.api#documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8876,7 +9032,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting STRING type document attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#StringAttributeValueBoosting": { @@ -8935,7 +9091,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information on boosting STRING_LIST type document\n attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.
" + "smithy.api#documentation": "Provides information on boosting STRING_LIST type document\n attributes.
For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.
For more information on how boosting document attributes work in Amazon Q Business, see\n Boosting using document attributes.
" } }, "com.amazonaws.qbusiness#SubnetId": { @@ -8988,7 +9144,7 @@ "key": { "target": "com.amazonaws.qbusiness#TagKey", "traits": { - "smithy.api#documentation": "The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q application or data source.
", + "smithy.api#documentation": "The key for the tag. Keys are not case sensitive and must be unique for the\n Amazon Q Business application or data source.
", "smithy.api#required": {} } }, @@ -9054,7 +9210,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified tag to the specified Amazon Q application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.
", + "smithy.api#documentation": "Adds the specified tag to the specified Amazon Q Business application or data source\n resource. If the tag already exists, the existing value is replaced with the new\n value.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "POST" @@ -9068,7 +9224,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to\n tag.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to\n tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9076,7 +9232,7 @@ "tags": { "target": "com.amazonaws.qbusiness#Tags", "traits": { - "smithy.api#documentation": "A list of tag keys to add to the Amazon Q application or data source. If a tag\n already exists, the existing value is replaced with the new value.
", + "smithy.api#documentation": "A list of tag keys to add to the Amazon Q Business application or data source. If a tag\n already exists, the existing value is replaced with the new value.
", "smithy.api#required": {} } } @@ -9218,7 +9374,7 @@ } }, "traits": { - "smithy.api#documentation": "The topic specific controls configured for an Amazon Q application.
" + "smithy.api#documentation": "The topic specific controls configured for an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#TopicConfigurationName": { @@ -9278,7 +9434,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a tag from an Amazon Q application or a data source.
", + "smithy.api#documentation": "Removes a tag from an Amazon Q Business application or a data source.
", "smithy.api#http": { "uri": "/v1/tags/{resourceARN}", "method": "DELETE" @@ -9292,7 +9448,7 @@ "resourceARN": { "target": "com.amazonaws.qbusiness#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q application, or data source to\n remove the tag from.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to\n remove the tag from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9300,7 +9456,7 @@ "tagKeys": { "target": "com.amazonaws.qbusiness#TagKeys", "traits": { - "smithy.api#documentation": "A list of tag keys to remove from the Amazon Q application or data source. If a\n tag key does not exist on the resource, it is ignored.
", + "smithy.api#documentation": "A list of tag keys to remove from the Amazon Q Business application or data source. If a\n tag key does not exist on the resource, it is ignored.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -9353,7 +9509,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an existing Amazon Q application.
", + "smithy.api#documentation": "Updates an existing Amazon Q Business application.
", "smithy.api#http": { "uri": "/applications/{applicationId}", "method": "PUT" @@ -9367,7 +9523,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9375,19 +9531,19 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "A name for the Amazon Q application.
" + "smithy.api#documentation": "A name for the Amazon Q Business application.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "A description for the Amazon Q application.
" + "smithy.api#documentation": "A description for the Amazon Q Business application.
" } }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q permission to access Amazon CloudWatch logs and\n metrics.
" + "smithy.api#documentation": "An Amazon Web Services Identity and Access Management (IAM) role that\n gives Amazon Q Business permission to access Amazon CloudWatch logs and\n metrics.
" } }, "attachmentsConfiguration": { @@ -9440,7 +9596,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an set of chat controls configured for an existing Amazon Q\n application.
", + "smithy.api#documentation": "Updates an set of chat controls configured for an existing Amazon Q Business\n application.
", "smithy.api#http": { "uri": "/applications/{applicationId}/chatcontrols", "method": "PATCH", @@ -9463,7 +9619,7 @@ "clientToken": { "target": "com.amazonaws.qbusiness#ClientToken", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to update a Amazon Q application\n chat configuration.
", + "smithy.api#documentation": "A token that you provide to identify the request to update a Amazon Q Business application\n chat configuration.
", "smithy.api#idempotencyToken": {} } }, @@ -9490,6 +9646,12 @@ "traits": { "smithy.api#documentation": "The configured topic specific chat controls you want to delete.
" } + }, + "creatorModeConfiguration": { + "target": "com.amazonaws.qbusiness#CreatorModeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for CREATOR_MODE.
Updates an existing Amazon Q data source connector.
", + "smithy.api#documentation": "Updates an existing Amazon Q Business data source connector.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}", "method": "PUT" @@ -9553,7 +9715,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application the data source is attached\n to.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application the data source is attached\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9657,7 +9819,7 @@ "qbusiness:UntagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "Updates an Amazon Q index.
", + "smithy.api#documentation": "Updates an Amazon Q Business index.
", "smithy.api#http": { "uri": "/applications/{applicationId}/indices/{indexId}", "method": "PUT" @@ -9671,7 +9833,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application connected to the index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application connected to the index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9679,7 +9841,7 @@ "indexId": { "target": "com.amazonaws.qbusiness#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q index.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business index.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9687,19 +9849,19 @@ "displayName": { "target": "com.amazonaws.qbusiness#ApplicationName", "traits": { - "smithy.api#documentation": "The name of the Amazon Q index.
" + "smithy.api#documentation": "The name of the Amazon Q Business index.
" } }, "description": { "target": "com.amazonaws.qbusiness#Description", "traits": { - "smithy.api#documentation": "The description of the Amazon Q index.
" + "smithy.api#documentation": "The description of the Amazon Q Business index.
" } }, "capacityConfiguration": { "target": "com.amazonaws.qbusiness#IndexCapacityConfiguration", "traits": { - "smithy.api#documentation": "The storage capacity units you want to provision for your Amazon Q index. You can\n add and remove capacity to fit your usage needs.
" + "smithy.api#documentation": "The storage capacity units you want to provision for your Amazon Q Business index. You can\n add and remove capacity to fit your usage needs.
" } }, "documentAttributeConfigurations": { @@ -9759,7 +9921,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an Amazon Q plugin.
", + "smithy.api#documentation": "Updates an Amazon Q Business plugin.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/plugins/{pluginId}" @@ -9861,7 +10023,7 @@ "qbusiness:GetRetriever", "iam:PassRole" ], - "smithy.api#documentation": "Updates the retriever used for your Amazon Q application.
", + "smithy.api#documentation": "Updates the retriever used for your Amazon Q Business application.
", "smithy.api#http": { "method": "PUT", "uri": "/applications/{applicationId}/retrievers/{retrieverId}" @@ -9875,7 +10037,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q application.
", + "smithy.api#documentation": "The identifier of your Amazon Q Business application.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10050,7 +10212,7 @@ "qbusiness:ListTagsForResource", "iam:PassRole" ], - "smithy.api#documentation": "Updates an Amazon Q web experience.
", + "smithy.api#documentation": "Updates an Amazon Q Business web experience.
", "smithy.api#http": { "uri": "/applications/{applicationId}/experiences/{webExperienceId}", "method": "PUT" @@ -10064,7 +10226,7 @@ "applicationId": { "target": "com.amazonaws.qbusiness#ApplicationId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q application attached to the web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business application attached to the web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10072,7 +10234,7 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Q web experience.
", + "smithy.api#documentation": "The identifier of the Amazon Q Business web experience.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10080,25 +10242,25 @@ "authenticationConfiguration": { "target": "com.amazonaws.qbusiness#WebExperienceAuthConfiguration", "traits": { - "smithy.api#documentation": "The authentication configuration of the Amazon Q web experience.
" + "smithy.api#documentation": "The authentication configuration of the Amazon Q Business web experience.
" } }, "title": { "target": "com.amazonaws.qbusiness#WebExperienceTitle", "traits": { - "smithy.api#documentation": "The title of the Amazon Q web experience.
" + "smithy.api#documentation": "The title of the Amazon Q Business web experience.
" } }, "subtitle": { "target": "com.amazonaws.qbusiness#WebExperienceSubtitle", "traits": { - "smithy.api#documentation": "The subtitle of the Amazon Q web experience.
" + "smithy.api#documentation": "The subtitle of the Amazon Q Business web experience.
" } }, "welcomeMessage": { "target": "com.amazonaws.qbusiness#WebExperienceWelcomeMessage", "traits": { - "smithy.api#documentation": "A customized welcome message for an end user in an Amazon Q web\n experience.
" + "smithy.api#documentation": "A customized welcome message for an end user in an Amazon Q Business web\n experience.
" } }, "samplePromptsControlMode": { @@ -10153,7 +10315,7 @@ } }, "traits": { - "smithy.api#documentation": "Aliases attached to a user id within an Amazon Q application.
" + "smithy.api#documentation": "Aliases attached to a user id within an Amazon Q Business application.
" } }, "com.amazonaws.qbusiness#UserAliases": { @@ -10238,7 +10400,7 @@ } }, "traits": { - "smithy.api#documentation": "The input doesn't meet the constraints set by the Amazon Q service. Provide the\n correct input and try again.
", + "smithy.api#documentation": "The input doesn't meet the constraints set by the Amazon Q Business service. Provide the\n correct input and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10262,7 +10424,7 @@ } }, "traits": { - "smithy.api#documentation": "The input failed to meet the constraints specified by Amazon Q in a specified\n field.
" + "smithy.api#documentation": "The input failed to meet the constraints specified by Amazon Q Business in a specified\n field.
" } }, "com.amazonaws.qbusiness#ValidationExceptionFields": { @@ -10300,36 +10462,36 @@ "webExperienceId": { "target": "com.amazonaws.qbusiness#WebExperienceId", "traits": { - "smithy.api#documentation": "The identifier of your Amazon Q web experience.
" + "smithy.api#documentation": "The identifier of your Amazon Q Business web experience.
" } }, "createdAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "smithy.api#documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, "updatedAt": { "target": "com.amazonaws.qbusiness#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp when your Amazon Q web experience was updated.
" + "smithy.api#documentation": "The Unix timestamp when your Amazon Q Business web experience was updated.
" } }, "defaultEndpoint": { "target": "com.amazonaws.qbusiness#Url", "traits": { - "smithy.api#documentation": "The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully\n hosted by Amazon Web Services.
" + "smithy.api#documentation": "The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully\n hosted by Amazon Web Services.
" } }, "status": { "target": "com.amazonaws.qbusiness#WebExperienceStatus", "traits": { - "smithy.api#documentation": "The status of your Amazon Q web experience.
" + "smithy.api#documentation": "The status of your Amazon Q Business web experience.
" } } }, "traits": { - "smithy.api#documentation": "Provides information for an Amazon Q web experience.
" + "smithy.api#documentation": "Provides information for an Amazon Q Business web experience.
" } }, "com.amazonaws.qbusiness#WebExperienceArn": { @@ -10350,7 +10512,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the authorization configuration information needed to deploy a Amazon Q\n web experience to end users.
" + "smithy.api#documentation": "Provides the authorization configuration information needed to deploy a Amazon Q Business\n web experience to end users.
" } }, "com.amazonaws.qbusiness#WebExperienceId": {