Skip to content

Commit a8de200

Browse files
author
awstools
committed
feat(client-qbusiness): This release adds support for IAM Identity Center (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.
1 parent b1ea1f2 commit a8de200

File tree

62 files changed

+1287
-898
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1287
-898
lines changed

‎clients/client-qbusiness/README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,20 @@ AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
99
<note>
1010
<p>Amazon Q is in preview release and is subject to change.</p>
1111
</note>
12-
<p>This is the <i>Amazon Q (for business use)</i> API Reference.
13-
Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
14-
you can deploy within your organization. Amazon Q enhances employee productivity by
15-
supporting key tasks such as question-answering, knowledge discovery, writing email
16-
messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
17-
ask questions of Amazon Q and get answers that are presented in a conversational
18-
manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
19-
<i>Amazon Q (for business use) Developer
20-
Guide</i>
12+
<p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
13+
managed, generative-AI powered enterprise chat assistant that you can deploy within your
14+
organization. Amazon Q Business enhances employee productivity by supporting key tasks such
15+
as question-answering, knowledge discovery, writing email messages, summarizing text,
16+
drafting document outlines, and brainstorming ideas. Users ask questions of
17+
Amazon Q Business and get answers that are presented in a conversational manner. For an
18+
introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
19+
<i>Amazon Q Business User Guide</i>
2120
</a>.</p>
22-
<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>
21+
<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>
2322
<p>For information about the IAM access control permissions you need to
24-
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
25-
<i>Amazon Q (for business use) Developer Guide</i>.</p>
26-
<p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
23+
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
24+
<i>Amazon Q Business User Guide</i>.</p>
25+
<p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
2726
<ul>
2827
<li>
2928
<p>
@@ -63,21 +62,21 @@ JavaScript</a>
6362
</p>
6463
</li>
6564
</ul>
66-
<p>The following resources provide additional information about using the Amazon Q
65+
<p>The following resources provide additional information about using the Amazon Q Business
6766
API:</p>
6867
<ul>
6968
<li>
7069
<p>
7170
<i>
7271
<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
73-
Amazon Q</a>
72+
Amazon Q Business</a>
7473
</i>
7574
</p>
7675
</li>
7776
<li>
7877
<p>
7978
<i>
80-
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
79+
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
8180
</i>
8281
</p>
8382
</li>

‎clients/client-qbusiness/src/QBusiness.ts

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1033,21 +1033,20 @@ export interface QBusiness {
10331033
* <note>
10341034
* <p>Amazon Q is in preview release and is subject to change.</p>
10351035
* </note>
1036-
* <p>This is the <i>Amazon Q (for business use)</i> API Reference.
1037-
* Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
1038-
* you can deploy within your organization. Amazon Q enhances employee productivity by
1039-
* supporting key tasks such as question-answering, knowledge discovery, writing email
1040-
* messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
1041-
* ask questions of Amazon Q and get answers that are presented in a conversational
1042-
* manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
1043-
* <i>Amazon Q (for business use) Developer
1044-
* Guide</i>
1036+
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
1037+
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
1038+
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
1039+
* as question-answering, knowledge discovery, writing email messages, summarizing text,
1040+
* drafting document outlines, and brainstorming ideas. Users ask questions of
1041+
* Amazon Q Business and get answers that are presented in a conversational manner. For an
1042+
* introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
1043+
* <i>Amazon Q Business User Guide</i>
10451044
* </a>.</p>
1046-
* <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>
1045+
* <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>
10471046
* <p>For information about the IAM access control permissions you need to
1048-
* 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
1049-
* <i>Amazon Q (for business use) Developer Guide</i>.</p>
1050-
* <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
1047+
* 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
1048+
* <i>Amazon Q Business User Guide</i>.</p>
1049+
* <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
10511050
* <ul>
10521051
* <li>
10531052
* <p>
@@ -1087,21 +1086,21 @@ export interface QBusiness {
10871086
* </p>
10881087
* </li>
10891088
* </ul>
1090-
* <p>The following resources provide additional information about using the Amazon Q
1089+
* <p>The following resources provide additional information about using the Amazon Q Business
10911090
* API:</p>
10921091
* <ul>
10931092
* <li>
10941093
* <p>
10951094
* <i>
10961095
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
1097-
* Amazon Q</a>
1096+
* Amazon Q Business</a>
10981097
* </i>
10991098
* </p>
11001099
* </li>
11011100
* <li>
11021101
* <p>
11031102
* <i>
1104-
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
1103+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
11051104
* </i>
11061105
* </p>
11071106
* </li>

‎clients/client-qbusiness/src/QBusinessClient.ts

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -447,21 +447,20 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
447447
* <note>
448448
* <p>Amazon Q is in preview release and is subject to change.</p>
449449
* </note>
450-
* <p>This is the <i>Amazon Q (for business use)</i> API Reference.
451-
* Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
452-
* you can deploy within your organization. Amazon Q enhances employee productivity by
453-
* supporting key tasks such as question-answering, knowledge discovery, writing email
454-
* messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
455-
* ask questions of Amazon Q and get answers that are presented in a conversational
456-
* manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
457-
* <i>Amazon Q (for business use) Developer
458-
* Guide</i>
450+
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
451+
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
452+
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
453+
* as question-answering, knowledge discovery, writing email messages, summarizing text,
454+
* drafting document outlines, and brainstorming ideas. Users ask questions of
455+
* Amazon Q Business and get answers that are presented in a conversational manner. For an
456+
* introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
457+
* <i>Amazon Q Business User Guide</i>
459458
* </a>.</p>
460-
* <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>
459+
* <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>
461460
* <p>For information about the IAM access control permissions you need to
462-
* 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
463-
* <i>Amazon Q (for business use) Developer Guide</i>.</p>
464-
* <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
461+
* 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
462+
* <i>Amazon Q Business User Guide</i>.</p>
463+
* <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
465464
* <ul>
466465
* <li>
467466
* <p>
@@ -501,21 +500,21 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
501500
* </p>
502501
* </li>
503502
* </ul>
504-
* <p>The following resources provide additional information about using the Amazon Q
503+
* <p>The following resources provide additional information about using the Amazon Q Business
505504
* API:</p>
506505
* <ul>
507506
* <li>
508507
* <p>
509508
* <i>
510509
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
511-
* Amazon Q</a>
510+
* Amazon Q Business</a>
512511
* </i>
513512
* </p>
514513
* </li>
515514
* <li>
516515
* <p>
517516
* <i>
518-
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
517+
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
519518
* </i>
520519
* </p>
521520
* </li>

‎clients/client-qbusiness/src/commands/BatchDeleteDocumentCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
2828

2929
/**
3030
* <p>Asynchronously deletes one or more documents added using the
31-
* <code>BatchPutDocument</code> API from an Amazon Q index.</p>
31+
* <code>BatchPutDocument</code> API from an Amazon Q Business index.</p>
3232
* <p>You can see the progress of the deletion, and any error messages related to the
3333
* process, by using CloudWatch.</p>
3434
* @example
@@ -79,7 +79,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
7979
* resource. Fix any inconsistences with your resources and try again.</p>
8080
*
8181
* @throws {@link InternalServerException} (server fault)
82-
* <p>An issue occurred with the internal server used for your Amazon Q service. Wait
82+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
8383
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
8484
*
8585
* @throws {@link ResourceNotFoundException} (client fault)
@@ -91,7 +91,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
9191
* again.</p>
9292
*
9393
* @throws {@link ValidationException} (client fault)
94-
* <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
94+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
9595
* correct input and try again.</p>
9696
*
9797
* @throws {@link QBusinessServiceException}

‎clients/client-qbusiness/src/commands/BatchPutDocumentCommand.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ export interface BatchPutDocumentCommandInput extends BatchPutDocumentRequest {}
2727
export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Adds one or more documents to an Amazon Q index.</p>
30+
* <p>Adds one or more documents to an Amazon Q Business index.</p>
3131
* <p>You use this API to:</p>
3232
* <ul>
3333
* <li>
3434
* <p>ingest your structured and unstructured documents and documents stored in an
35-
* Amazon S3 bucket into an Amazon Q index.</p>
35+
* Amazon S3 bucket into an Amazon Q Business index.</p>
3636
* </li>
3737
* <li>
38-
* <p>add custom attributes to documents in an Amazon Q index.</p>
38+
* <p>add custom attributes to documents in an Amazon Q Business index.</p>
3939
* </li>
4040
* <li>
41-
* <p>attach an access control list to the documents added to an Amazon Q
41+
* <p>attach an access control list to the documents added to an Amazon Q Business
4242
* index.</p>
4343
* </li>
4444
* </ul>
@@ -188,22 +188,22 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
188188
* resource. Fix any inconsistences with your resources and try again.</p>
189189
*
190190
* @throws {@link InternalServerException} (server fault)
191-
* <p>An issue occurred with the internal server used for your Amazon Q service. Wait
191+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
192192
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
193193
*
194194
* @throws {@link ResourceNotFoundException} (client fault)
195195
* <p>The resource you want to use doesn’t exist. Make sure you have provided the correct
196196
* resource and try again.</p>
197197
*
198198
* @throws {@link ServiceQuotaExceededException} (client fault)
199-
* <p>You have exceeded the set limits for your Amazon Q service. </p>
199+
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
200200
*
201201
* @throws {@link ThrottlingException} (client fault)
202202
* <p>The request was denied due to throttling. Reduce the number of requests and try
203203
* again.</p>
204204
*
205205
* @throws {@link ValidationException} (client fault)
206-
* <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
206+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
207207
* correct input and try again.</p>
208208
*
209209
* @throws {@link QBusinessServiceException}

‎clients/client-qbusiness/src/commands/ChatSyncCommand.ts

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface ChatSyncCommandInput extends ChatSyncInput {}
2727
export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer {}
2828

2929
/**
30-
* <p>Starts or continues a non-streaming Amazon Q conversation.</p>
30+
* <p>Starts or continues a non-streaming Amazon Q Business conversation.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript
@@ -36,7 +36,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
3636
* const client = new QBusinessClient(config);
3737
* const input = { // ChatSyncInput
3838
* applicationId: "STRING_VALUE", // required
39-
* userId: "STRING_VALUE", // required
39+
* userId: "STRING_VALUE",
4040
* userGroups: [ // UserGroups
4141
* "STRING_VALUE",
4242
* ],
@@ -139,6 +139,12 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
139139
* lessThan: "<DocumentAttribute>",
140140
* lessThanOrEquals: "<DocumentAttribute>",
141141
* },
142+
* chatMode: "RETRIEVAL_MODE" || "CREATOR_MODE" || "PLUGIN_MODE",
143+
* chatModeConfiguration: { // ChatModeConfiguration Union: only one key present
144+
* pluginConfiguration: { // PluginConfiguration
145+
* pluginId: "STRING_VALUE", // required
146+
* },
147+
* },
142148
* clientToken: "STRING_VALUE",
143149
* };
144150
* const command = new ChatSyncCommand(input);
@@ -212,7 +218,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
212218
* resource. Fix any inconsistences with your resources and try again.</p>
213219
*
214220
* @throws {@link InternalServerException} (server fault)
215-
* <p>An issue occurred with the internal server used for your Amazon Q service. Wait
221+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
216222
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
217223
*
218224
* @throws {@link LicenseNotFoundException} (client fault)
@@ -228,7 +234,7 @@ export interface ChatSyncCommandOutput extends ChatSyncOutput, __MetadataBearer
228234
* again.</p>
229235
*
230236
* @throws {@link ValidationException} (client fault)
231-
* <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
237+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
232238
* correct input and try again.</p>
233239
*
234240
* @throws {@link QBusinessServiceException}

0 commit comments

Comments
 (0)