feat(client-qbusiness): This release adds support for IAM Identity Ce…

…nter (IDC) as the identity gateway for Q Business. It also allows users to provide an explicit intent for Q Business to identify how the Chat request should be handled.
aws · Apr 17, 2024 · a8de200 · a8de200
1 parent b1ea1f2
commit a8de200
Show file tree

Hide file tree

Showing 62 changed files with 1,287 additions and 898 deletions.
diff --git a/clients/client-qbusiness/README.md b/clients/client-qbusiness/README.md
@@ -9,21 +9,20 @@ AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
 <note>
 <p>Amazon Q is in preview release and is subject to change.</p>
 </note>
-<p>This is the <i>Amazon Q (for business use)</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
-<i>Amazon Q (for business use) Developer
-Guide</i>
+<p>This is the <i>Amazon Q Business</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+<i>Amazon Q Business User Guide</i>
 </a>.</p>
-<p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+<p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
 <p>For information about the IAM access control permissions you need to
-use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
-<i>Amazon Q (for business use) Developer Guide</i>.</p>
-<p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
+<i>Amazon Q Business User Guide</i>.</p>
+<p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
 <ul>
 <li>
 <p>
@@ -63,21 +62,21 @@ JavaScript</a>
 </p>
 </li>
 </ul>
-<p>The following resources provide additional information about using the Amazon Q
+<p>The following resources provide additional information about using the Amazon Q Business
 API:</p>
 <ul>
 <li>
 <p>
 <i>
 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
-Amazon Q</a>
+Amazon Q Business</a>
 </i>
 </p>
 </li>
 <li>
 <p>
 <i>
-<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
 </i>
 </p>
 </li>

diff --git a/clients/client-qbusiness/src/QBusiness.ts b/clients/client-qbusiness/src/QBusiness.ts
@@ -1033,21 +1033,20 @@ export interface QBusiness {
  * <note>
  *             <p>Amazon Q is in preview release and is subject to change.</p>
  *          </note>
- *          <p>This is the <i>Amazon Q (for business use)</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
- *                <i>Amazon Q (for business use) Developer
- *             Guide</i>
+ *          <p>This is the <i>Amazon Q Business</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+ *                <i>Amazon Q Business User Guide</i>
  *             </a>.</p>
- *          <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+ *          <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
  *          <p>For information about the IAM access control permissions you need to
- *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
- *                 <i>Amazon Q (for business use) Developer Guide</i>.</p>
- *          <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+ *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
+ *                 <i>Amazon Q Business User Guide</i>.</p>
+ *          <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
  *          <ul>
  *             <li>
  *                <p>
@@ -1087,21 +1086,21 @@ export interface QBusiness {
  *                </p>
  *             </li>
  *          </ul>
- *          <p>The following resources provide additional information about using the Amazon Q
+ *          <p>The following resources provide additional information about using the Amazon Q Business
  *             API:</p>
  *          <ul>
  *             <li>
  *                <p>
  *                   <i>
  *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
- *                             Amazon Q</a>
+ *                             Amazon Q Business</a>
  *                   </i>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
  *                   <i>
- *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+ *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
  *                   </i>
  *                </p>
  *             </li>

diff --git a/clients/client-qbusiness/src/QBusinessClient.ts b/clients/client-qbusiness/src/QBusinessClient.ts
@@ -447,21 +447,20 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
  * <note>
  *             <p>Amazon Q is in preview release and is subject to change.</p>
  *          </note>
- *          <p>This is the <i>Amazon Q (for business use)</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
- *                <i>Amazon Q (for business use) Developer
- *             Guide</i>
+ *          <p>This is the <i>Amazon Q Business</i> 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 <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
+ *                <i>Amazon Q Business User Guide</i>
  *             </a>.</p>
- *          <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
+ *          <p>For an overview of the Amazon Q Business APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q Business API operations</a>.</p>
  *          <p>For information about the IAM access control permissions you need to
- *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
- *                 <i>Amazon Q (for business use) Developer Guide</i>.</p>
- *          <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
+ *             use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q Business</a> in the
+ *                 <i>Amazon Q Business User Guide</i>.</p>
+ *          <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
  *          <ul>
  *             <li>
  *                <p>
@@ -501,21 +500,21 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
  *                </p>
  *             </li>
  *          </ul>
- *          <p>The following resources provide additional information about using the Amazon Q
+ *          <p>The following resources provide additional information about using the Amazon Q Business
  *             API:</p>
  *          <ul>
  *             <li>
  *                <p>
  *                   <i>
  *                      <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
- *                             Amazon Q</a>
+ *                             Amazon Q Business</a>
  *                   </i>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
  *                   <i>
- *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
+ *                      <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
  *                   </i>
  *                </p>
  *             </li>

diff --git a/clients/client-qbusiness/src/commands/BatchDeleteDocumentCommand.ts b/clients/client-qbusiness/src/commands/BatchDeleteDocumentCommand.ts
@@ -28,7 +28,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
 
 /**
  * <p>Asynchronously deletes one or more documents added using the
- *                 <code>BatchPutDocument</code> API from an Amazon Q index.</p>
+ *                 <code>BatchPutDocument</code> API from an Amazon Q Business index.</p>
  *          <p>You can see the progress of the deletion, and any error messages related to the
  *             process, by using CloudWatch.</p>
  * @example
@@ -79,7 +79,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
  *             resource. Fix any inconsistences with your resources and try again.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An issue occurred with the internal server used for your Amazon Q service. Wait
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
  *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -91,7 +91,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
  *             again.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
  *             correct input and try again.</p>
  *
  * @throws {@link QBusinessServiceException}

diff --git 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 {}
 
 /**
- * <p>Adds one or more documents to an Amazon Q index.</p>
+ * <p>Adds one or more documents to an Amazon Q Business index.</p>
  *          <p>You use this API to:</p>
  *          <ul>
  *             <li>
  *                <p>ingest your structured and unstructured documents and documents stored in an
- *                         Amazon S3 bucket into an Amazon Q index.</p>
+ *                         Amazon S3 bucket into an Amazon Q Business index.</p>
  *             </li>
  *             <li>
- *                <p>add custom attributes to documents in an Amazon Q index.</p>
+ *                <p>add custom attributes to documents in an Amazon Q Business index.</p>
  *             </li>
  *             <li>
- *                <p>attach an access control list to the documents added to an Amazon Q
+ *                <p>attach an access control list to the documents added to an Amazon Q Business
  *                     index.</p>
  *             </li>
  *          </ul>
@@ -188,22 +188,22 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
  *             resource. Fix any inconsistences with your resources and try again.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An issue occurred with the internal server used for your Amazon Q service. Wait
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
  *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
  *             resource and try again.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p>You have exceeded the set limits for your Amazon Q service. </p>
+ *  <p>You have exceeded the set limits for your Amazon Q Business service. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to throttling. Reduce the number of requests and try
  *             again.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
  *             correct input and try again.</p>
  *
  * @throws {@link QBusinessServiceException}

diff --git 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 {}
 
 /**
- * <p>Starts or continues a non-streaming Amazon Q conversation.</p>
+ * <p>Starts or continues a non-streaming Amazon Q Business conversation.</p>
  * @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: "<DocumentAttribute>",
  *     lessThanOrEquals: "<DocumentAttribute>",
  *   },
+ *   chatMode: "RETRIEVAL_MODE" || "CREATOR_MODE" || "PLUGIN_MODE",
+ *   chatModeConfiguration: { // ChatModeConfiguration Union: only one key present
+ *     pluginConfiguration: { // PluginConfiguration
+ *       pluginId: "STRING_VALUE", // required
+ *     },
+ *   },
  *   clientToken: "STRING_VALUE",
  * };
  * const command = new ChatSyncCommand(input);
@@ -212,7 +218,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
  *             resource. Fix any inconsistences with your resources and try again.</p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>An issue occurred with the internal server used for your Amazon Q service. Wait
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
  *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link LicenseNotFoundException} (client fault)
@@ -228,7 +234,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
  *             again.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
  *             correct input and try again.</p>
  *
  * @throws {@link QBusinessServiceException}