@aws-sdk/client-qbusiness 3.782.0 → 3.793.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -39
- package/dist-cjs/index.js +69 -5
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/commands/CheckDocumentAccessCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +8 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +34 -0
- package/dist-types/QBusiness.d.ts +8 -39
- package/dist-types/QBusinessClient.d.ts +4 -41
- package/dist-types/commands/AssociatePermissionCommand.d.ts +7 -15
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +7 -16
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -29
- package/dist-types/commands/CancelSubscriptionCommand.d.ts +6 -13
- package/dist-types/commands/ChatCommand.d.ts +9 -17
- package/dist-types/commands/ChatSyncCommand.d.ts +8 -17
- package/dist-types/commands/CheckDocumentAccessCommand.d.ts +145 -0
- package/dist-types/commands/CreateApplicationCommand.d.ts +7 -27
- package/dist-types/commands/CreateDataAccessorCommand.d.ts +7 -18
- package/dist-types/commands/CreateDataSourceCommand.d.ts +7 -16
- package/dist-types/commands/CreateIndexCommand.d.ts +7 -21
- package/dist-types/commands/CreatePluginCommand.d.ts +6 -12
- package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +7 -18
- package/dist-types/commands/CreateUserCommand.d.ts +7 -14
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DeleteApplicationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteAttachmentCommand.d.ts +6 -12
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +5 -10
- package/dist-types/commands/DeleteConversationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteDataAccessorCommand.d.ts +7 -14
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -15
- package/dist-types/commands/DeleteGroupCommand.d.ts +7 -21
- package/dist-types/commands/DeleteIndexCommand.d.ts +6 -12
- package/dist-types/commands/DeletePluginCommand.d.ts +6 -12
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/DeleteUserCommand.d.ts +6 -12
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DisassociatePermissionCommand.d.ts +7 -14
- package/dist-types/commands/GetApplicationCommand.d.ts +5 -10
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/GetDataAccessorCommand.d.ts +6 -14
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -10
- package/dist-types/commands/GetGroupCommand.d.ts +6 -12
- package/dist-types/commands/GetIndexCommand.d.ts +5 -10
- package/dist-types/commands/GetMediaCommand.d.ts +7 -16
- package/dist-types/commands/GetPluginCommand.d.ts +5 -10
- package/dist-types/commands/GetPolicyCommand.d.ts +6 -12
- package/dist-types/commands/GetRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/GetUserCommand.d.ts +7 -14
- package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -10
- package/dist-types/commands/ListApplicationsCommand.d.ts +5 -15
- package/dist-types/commands/ListAttachmentsCommand.d.ts +6 -12
- package/dist-types/commands/ListConversationsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataAccessorsCommand.d.ts +6 -13
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataSourcesCommand.d.ts +5 -10
- package/dist-types/commands/ListDocumentsCommand.d.ts +7 -11
- package/dist-types/commands/ListGroupsCommand.d.ts +7 -13
- package/dist-types/commands/ListIndicesCommand.d.ts +5 -10
- package/dist-types/commands/ListMessagesCommand.d.ts +7 -13
- package/dist-types/commands/ListPluginActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +4 -8
- package/dist-types/commands/ListPluginsCommand.d.ts +5 -10
- package/dist-types/commands/ListRetrieversCommand.d.ts +5 -10
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +6 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -12
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +5 -10
- package/dist-types/commands/PutFeedbackCommand.d.ts +6 -12
- package/dist-types/commands/PutGroupCommand.d.ts +7 -23
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +7 -18
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/TagResourceCommand.d.ts +7 -15
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -10
- package/dist-types/commands/UpdateApplicationCommand.d.ts +7 -25
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +10 -14
- package/dist-types/commands/UpdateDataAccessorCommand.d.ts +7 -15
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -12
- package/dist-types/commands/UpdateIndexCommand.d.ts +6 -12
- package/dist-types/commands/UpdatePluginCommand.d.ts +6 -12
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/UpdateSubscriptionCommand.d.ts +7 -16
- package/dist-types/commands/UpdateUserCommand.d.ts +8 -10
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -39
- package/dist-types/models/models_0.d.ts +542 -1258
- package/dist-types/models/models_1.d.ts +309 -175
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QBusiness.d.ts +17 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CheckDocumentAccessCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -64
- package/dist-types/ts3.4/models/models_1.d.ts +73 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,45 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript QBusiness Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
10
|
-
managed, generative-AI powered enterprise chat assistant that you can deploy within your
|
|
11
|
-
organization. Amazon Q Business enhances employee productivity by supporting key tasks such
|
|
12
|
-
as question-answering, knowledge discovery, writing email messages, summarizing text,
|
|
13
|
-
drafting document outlines, and brainstorming ideas. Users ask questions of
|
|
14
|
-
Amazon Q Business and get answers that are presented in a conversational manner. For an
|
|
15
|
-
introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
|
|
16
|
-
<i>Amazon Q Business User Guide</i>
|
|
17
|
-
</a>.</p>
|
|
18
|
-
<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>
|
|
19
|
-
<p>For information about the IAM access control permissions you need to
|
|
20
|
-
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
|
|
21
|
-
<i>Amazon Q Business User Guide</i>.</p>
|
|
22
|
-
<p>The following resources provide additional information about using the Amazon Q Business
|
|
23
|
-
API:</p>
|
|
24
|
-
<ul>
|
|
25
|
-
<li>
|
|
26
|
-
<p>
|
|
27
|
-
<i>
|
|
28
|
-
<a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
|
|
29
|
-
Amazon Q Business</a>
|
|
30
|
-
</i>
|
|
31
|
-
</p>
|
|
32
|
-
</li>
|
|
33
|
-
<li>
|
|
34
|
-
<p>
|
|
35
|
-
<i>
|
|
36
|
-
<a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
|
|
37
|
-
</i>
|
|
38
|
-
</p>
|
|
39
|
-
</li>
|
|
40
|
-
<li>
|
|
41
|
-
<p>
|
|
42
|
-
<i>
|
|
43
|
-
<a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
|
|
44
|
-
</i>
|
|
45
|
-
</p>
|
|
46
|
-
</li>
|
|
47
|
-
</ul>
|
|
9
|
+
<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 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 Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <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 Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
|
|
48
10
|
|
|
49
11
|
## Installing
|
|
50
12
|
|
|
@@ -288,6 +250,14 @@ ChatSync
|
|
|
288
250
|
|
|
289
251
|
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/ChatSyncCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ChatSyncCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/ChatSyncCommandOutput/)
|
|
290
252
|
|
|
253
|
+
</details>
|
|
254
|
+
<details>
|
|
255
|
+
<summary>
|
|
256
|
+
CheckDocumentAccess
|
|
257
|
+
</summary>
|
|
258
|
+
|
|
259
|
+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/qbusiness/command/CheckDocumentAccessCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/CheckDocumentAccessCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-qbusiness/Interface/CheckDocumentAccessCommandOutput/)
|
|
260
|
+
|
|
291
261
|
</details>
|
|
292
262
|
<details>
|
|
293
263
|
<summary>
|
package/dist-cjs/index.js
CHANGED
|
@@ -49,6 +49,7 @@ __export(index_exports, {
|
|
|
49
49
|
ChatOutputStream: () => ChatOutputStream,
|
|
50
50
|
ChatOutputStreamFilterSensitiveLog: () => ChatOutputStreamFilterSensitiveLog,
|
|
51
51
|
ChatSyncCommand: () => ChatSyncCommand,
|
|
52
|
+
CheckDocumentAccessCommand: () => CheckDocumentAccessCommand,
|
|
52
53
|
ConflictException: () => ConflictException,
|
|
53
54
|
ContentSource: () => ContentSource,
|
|
54
55
|
ContentType: () => ContentType,
|
|
@@ -109,6 +110,7 @@ __export(index_exports, {
|
|
|
109
110
|
GetUserCommand: () => GetUserCommand,
|
|
110
111
|
GetWebExperienceCommand: () => GetWebExperienceCommand,
|
|
111
112
|
GroupStatus: () => GroupStatus,
|
|
113
|
+
HallucinationReductionControl: () => HallucinationReductionControl,
|
|
112
114
|
IdentityProviderConfiguration: () => IdentityProviderConfiguration,
|
|
113
115
|
IdentityType: () => IdentityType,
|
|
114
116
|
ImageExtractionStatus: () => ImageExtractionStatus,
|
|
@@ -174,6 +176,7 @@ __export(index_exports, {
|
|
|
174
176
|
StringAttributeValueBoostingLevel: () => StringAttributeValueBoostingLevel,
|
|
175
177
|
SubscriptionPrincipal: () => SubscriptionPrincipal,
|
|
176
178
|
SubscriptionType: () => SubscriptionType,
|
|
179
|
+
SystemMessageType: () => SystemMessageType,
|
|
177
180
|
TagResourceCommand: () => TagResourceCommand,
|
|
178
181
|
ThrottlingException: () => ThrottlingException,
|
|
179
182
|
UntagResourceCommand: () => UntagResourceCommand,
|
|
@@ -911,6 +914,10 @@ var SourceDetails;
|
|
|
911
914
|
return visitor._(value.$unknown[0], value.$unknown[1]);
|
|
912
915
|
}, "visit");
|
|
913
916
|
})(SourceDetails || (SourceDetails = {}));
|
|
917
|
+
var SystemMessageType = {
|
|
918
|
+
GROUNDED_RESPONSE: "GROUNDED_RESPONSE",
|
|
919
|
+
RESPONSE: "RESPONSE"
|
|
920
|
+
};
|
|
914
921
|
var ChatOutputStream;
|
|
915
922
|
((ChatOutputStream3) => {
|
|
916
923
|
ChatOutputStream3.visit = /* @__PURE__ */ __name((value, visitor) => {
|
|
@@ -993,6 +1000,10 @@ var DocumentStatus = {
|
|
|
993
1000
|
RECEIVED: "RECEIVED",
|
|
994
1001
|
UPDATED: "UPDATED"
|
|
995
1002
|
};
|
|
1003
|
+
var HallucinationReductionControl = {
|
|
1004
|
+
DISABLED: "DISABLED",
|
|
1005
|
+
ENABLED: "ENABLED"
|
|
1006
|
+
};
|
|
996
1007
|
var ResponseScope = {
|
|
997
1008
|
ENTERPRISE_CONTENT_ONLY: "ENTERPRISE_CONTENT_ONLY",
|
|
998
1009
|
EXTENDED_KNOWLEDGE_ENABLED: "EXTENDED_KNOWLEDGE_ENABLED"
|
|
@@ -1034,10 +1045,6 @@ var MediaTooLargeException = class _MediaTooLargeException extends QBusinessServ
|
|
|
1034
1045
|
Object.setPrototypeOf(this, _MediaTooLargeException.prototype);
|
|
1035
1046
|
}
|
|
1036
1047
|
};
|
|
1037
|
-
var MessageType = {
|
|
1038
|
-
SYSTEM: "SYSTEM",
|
|
1039
|
-
USER: "USER"
|
|
1040
|
-
};
|
|
1041
1048
|
var APISchemaFilterSensitiveLog = /* @__PURE__ */ __name((obj) => {
|
|
1042
1049
|
if (obj.payload !== void 0) return { payload: import_smithy_client.SENSITIVE_STRING };
|
|
1043
1050
|
if (obj.s3 !== void 0) return { s3: obj.s3 };
|
|
@@ -1107,6 +1114,10 @@ var ChatOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
|
1107
1114
|
|
|
1108
1115
|
// src/models/models_1.ts
|
|
1109
1116
|
|
|
1117
|
+
var MessageType = {
|
|
1118
|
+
SYSTEM: "SYSTEM",
|
|
1119
|
+
USER: "USER"
|
|
1120
|
+
};
|
|
1110
1121
|
var PluginTypeCategory = {
|
|
1111
1122
|
COMMUNICATION: "Communication",
|
|
1112
1123
|
CRM: "Customer relationship management (CRM)",
|
|
@@ -1299,6 +1310,21 @@ var se_ChatSyncCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
|
1299
1310
|
b.m("POST").h(headers).q(query).b(body);
|
|
1300
1311
|
return b.build();
|
|
1301
1312
|
}, "se_ChatSyncCommand");
|
|
1313
|
+
var se_CheckDocumentAccessCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1314
|
+
const b = (0, import_core.requestBuilder)(input, context);
|
|
1315
|
+
const headers = {};
|
|
1316
|
+
b.bp("/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access");
|
|
1317
|
+
b.p("applicationId", () => input.applicationId, "{applicationId}", false);
|
|
1318
|
+
b.p("indexId", () => input.indexId, "{indexId}", false);
|
|
1319
|
+
b.p("userId", () => input.userId, "{userId}", false);
|
|
1320
|
+
b.p("documentId", () => input.documentId, "{documentId}", false);
|
|
1321
|
+
const query = (0, import_smithy_client.map)({
|
|
1322
|
+
[_dSI]: [, input[_dSI]]
|
|
1323
|
+
});
|
|
1324
|
+
let body;
|
|
1325
|
+
b.m("GET").h(headers).q(query).b(body);
|
|
1326
|
+
return b.build();
|
|
1327
|
+
}, "se_CheckDocumentAccessCommand");
|
|
1302
1328
|
var se_CreateApplicationCommand = /* @__PURE__ */ __name(async (input, context) => {
|
|
1303
1329
|
const b = (0, import_core.requestBuilder)(input, context);
|
|
1304
1330
|
const headers = {
|
|
@@ -2164,6 +2190,7 @@ var se_UpdateChatControlsConfigurationCommand = /* @__PURE__ */ __name(async (in
|
|
|
2164
2190
|
blockedPhrasesConfigurationUpdate: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "blockedPhrasesConfigurationUpdate"),
|
|
2165
2191
|
clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
|
|
2166
2192
|
creatorModeConfiguration: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "creatorModeConfiguration"),
|
|
2193
|
+
hallucinationReductionConfiguration: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "hallucinationReductionConfiguration"),
|
|
2167
2194
|
orchestrationConfiguration: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "orchestrationConfiguration"),
|
|
2168
2195
|
responseScope: [],
|
|
2169
2196
|
topicConfigurationsToCreateOrUpdate: /* @__PURE__ */ __name((_) => (0, import_smithy_client._json)(_), "topicConfigurationsToCreateOrUpdate"),
|
|
@@ -2427,6 +2454,23 @@ var de_ChatSyncCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
|
2427
2454
|
Object.assign(contents, doc);
|
|
2428
2455
|
return contents;
|
|
2429
2456
|
}, "de_ChatSyncCommand");
|
|
2457
|
+
var de_CheckDocumentAccessCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
2458
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2459
|
+
return de_CommandError(output, context);
|
|
2460
|
+
}
|
|
2461
|
+
const contents = (0, import_smithy_client.map)({
|
|
2462
|
+
$metadata: deserializeMetadata(output)
|
|
2463
|
+
});
|
|
2464
|
+
const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
|
|
2465
|
+
const doc = (0, import_smithy_client.take)(data, {
|
|
2466
|
+
documentAcl: import_smithy_client._json,
|
|
2467
|
+
hasAccess: import_smithy_client.expectBoolean,
|
|
2468
|
+
userAliases: import_smithy_client._json,
|
|
2469
|
+
userGroups: import_smithy_client._json
|
|
2470
|
+
});
|
|
2471
|
+
Object.assign(contents, doc);
|
|
2472
|
+
return contents;
|
|
2473
|
+
}, "de_CheckDocumentAccessCommand");
|
|
2430
2474
|
var de_CreateApplicationCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
2431
2475
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
2432
2476
|
return de_CommandError(output, context);
|
|
@@ -2734,6 +2778,7 @@ var de_GetChatControlsConfigurationCommand = /* @__PURE__ */ __name(async (outpu
|
|
|
2734
2778
|
const doc = (0, import_smithy_client.take)(data, {
|
|
2735
2779
|
blockedPhrases: import_smithy_client._json,
|
|
2736
2780
|
creatorModeConfiguration: import_smithy_client._json,
|
|
2781
|
+
hallucinationReductionConfiguration: import_smithy_client._json,
|
|
2737
2782
|
nextToken: import_smithy_client.expectString,
|
|
2738
2783
|
orchestrationConfiguration: import_smithy_client._json,
|
|
2739
2784
|
responseScope: import_smithy_client.expectString,
|
|
@@ -4483,6 +4528,21 @@ var ChatSyncCommand = class extends import_smithy_client.Command.classBuilder().
|
|
|
4483
4528
|
}
|
|
4484
4529
|
};
|
|
4485
4530
|
|
|
4531
|
+
// src/commands/CheckDocumentAccessCommand.ts
|
|
4532
|
+
|
|
4533
|
+
|
|
4534
|
+
|
|
4535
|
+
var CheckDocumentAccessCommand = class extends import_smithy_client.Command.classBuilder().ep(commonParams).m(function(Command, cs, config, o) {
|
|
4536
|
+
return [
|
|
4537
|
+
(0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
|
|
4538
|
+
(0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
|
|
4539
|
+
];
|
|
4540
|
+
}).s("ExpertQ", "CheckDocumentAccess", {}).n("QBusinessClient", "CheckDocumentAccessCommand").f(void 0, void 0).ser(se_CheckDocumentAccessCommand).de(de_CheckDocumentAccessCommand).build() {
|
|
4541
|
+
static {
|
|
4542
|
+
__name(this, "CheckDocumentAccessCommand");
|
|
4543
|
+
}
|
|
4544
|
+
};
|
|
4545
|
+
|
|
4486
4546
|
// src/commands/CreateApplicationCommand.ts
|
|
4487
4547
|
|
|
4488
4548
|
|
|
@@ -5526,6 +5586,7 @@ var commands = {
|
|
|
5526
5586
|
CancelSubscriptionCommand,
|
|
5527
5587
|
ChatCommand,
|
|
5528
5588
|
ChatSyncCommand,
|
|
5589
|
+
CheckDocumentAccessCommand,
|
|
5529
5590
|
CreateApplicationCommand,
|
|
5530
5591
|
CreateDataAccessorCommand,
|
|
5531
5592
|
CreateDataSourceCommand,
|
|
@@ -5692,6 +5753,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
5692
5753
|
CancelSubscriptionCommand,
|
|
5693
5754
|
ChatCommand,
|
|
5694
5755
|
ChatSyncCommand,
|
|
5756
|
+
CheckDocumentAccessCommand,
|
|
5695
5757
|
CreateApplicationCommand,
|
|
5696
5758
|
CreateDataAccessorCommand,
|
|
5697
5759
|
CreateDataSourceCommand,
|
|
@@ -5842,6 +5904,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
5842
5904
|
ChatModeConfiguration,
|
|
5843
5905
|
VideoExtractionType,
|
|
5844
5906
|
SourceDetails,
|
|
5907
|
+
SystemMessageType,
|
|
5845
5908
|
ChatOutputStream,
|
|
5846
5909
|
ExternalResourceException,
|
|
5847
5910
|
LicenseNotFoundException,
|
|
@@ -5849,12 +5912,12 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
5849
5912
|
SubscriptionPrincipal,
|
|
5850
5913
|
DataSourceSyncJobStatus,
|
|
5851
5914
|
DocumentStatus,
|
|
5915
|
+
HallucinationReductionControl,
|
|
5852
5916
|
ResponseScope,
|
|
5853
5917
|
RuleConfiguration,
|
|
5854
5918
|
RuleType,
|
|
5855
5919
|
GroupStatus,
|
|
5856
5920
|
MediaTooLargeException,
|
|
5857
|
-
MessageType,
|
|
5858
5921
|
APISchemaFilterSensitiveLog,
|
|
5859
5922
|
EncryptionConfigurationFilterSensitiveLog,
|
|
5860
5923
|
CreateApplicationRequestFilterSensitiveLog,
|
|
@@ -5867,6 +5930,7 @@ var paginateSearchRelevantContent = (0, import_core.createPaginator)(QBusinessCl
|
|
|
5867
5930
|
UpdatePluginRequestFilterSensitiveLog,
|
|
5868
5931
|
ChatOutputStreamFilterSensitiveLog,
|
|
5869
5932
|
ChatOutputFilterSensitiveLog,
|
|
5933
|
+
MessageType,
|
|
5870
5934
|
PluginTypeCategory,
|
|
5871
5935
|
MessageUsefulnessReason,
|
|
5872
5936
|
MessageUsefulness,
|
package/dist-es/QBusiness.js
CHANGED
|
@@ -5,6 +5,7 @@ import { BatchPutDocumentCommand, } from "./commands/BatchPutDocumentCommand";
|
|
|
5
5
|
import { CancelSubscriptionCommand, } from "./commands/CancelSubscriptionCommand";
|
|
6
6
|
import { ChatCommand } from "./commands/ChatCommand";
|
|
7
7
|
import { ChatSyncCommand } from "./commands/ChatSyncCommand";
|
|
8
|
+
import { CheckDocumentAccessCommand, } from "./commands/CheckDocumentAccessCommand";
|
|
8
9
|
import { CreateApplicationCommand, } from "./commands/CreateApplicationCommand";
|
|
9
10
|
import { CreateDataAccessorCommand, } from "./commands/CreateDataAccessorCommand";
|
|
10
11
|
import { CreateDataSourceCommand, } from "./commands/CreateDataSourceCommand";
|
|
@@ -82,6 +83,7 @@ const commands = {
|
|
|
82
83
|
CancelSubscriptionCommand,
|
|
83
84
|
ChatCommand,
|
|
84
85
|
ChatSyncCommand,
|
|
86
|
+
CheckDocumentAccessCommand,
|
|
85
87
|
CreateApplicationCommand,
|
|
86
88
|
CreateDataAccessorCommand,
|
|
87
89
|
CreateDataSourceCommand,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { de_CheckDocumentAccessCommand, se_CheckDocumentAccessCommand } from "../protocols/Aws_restJson1";
|
|
6
|
+
export { $Command };
|
|
7
|
+
export class CheckDocumentAccessCommand extends $Command
|
|
8
|
+
.classBuilder()
|
|
9
|
+
.ep(commonParams)
|
|
10
|
+
.m(function (Command, cs, config, o) {
|
|
11
|
+
return [
|
|
12
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
13
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
14
|
+
];
|
|
15
|
+
})
|
|
16
|
+
.s("ExpertQ", "CheckDocumentAccess", {})
|
|
17
|
+
.n("QBusinessClient", "CheckDocumentAccessCommand")
|
|
18
|
+
.f(void 0, void 0)
|
|
19
|
+
.ser(se_CheckDocumentAccessCommand)
|
|
20
|
+
.de(de_CheckDocumentAccessCommand)
|
|
21
|
+
.build() {
|
|
22
|
+
}
|
|
@@ -4,6 +4,7 @@ export * from "./BatchPutDocumentCommand";
|
|
|
4
4
|
export * from "./CancelSubscriptionCommand";
|
|
5
5
|
export * from "./ChatCommand";
|
|
6
6
|
export * from "./ChatSyncCommand";
|
|
7
|
+
export * from "./CheckDocumentAccessCommand";
|
|
7
8
|
export * from "./CreateApplicationCommand";
|
|
8
9
|
export * from "./CreateDataAccessorCommand";
|
|
9
10
|
export * from "./CreateDataSourceCommand";
|
|
@@ -465,6 +465,10 @@ export var SourceDetails;
|
|
|
465
465
|
return visitor._(value.$unknown[0], value.$unknown[1]);
|
|
466
466
|
};
|
|
467
467
|
})(SourceDetails || (SourceDetails = {}));
|
|
468
|
+
export const SystemMessageType = {
|
|
469
|
+
GROUNDED_RESPONSE: "GROUNDED_RESPONSE",
|
|
470
|
+
RESPONSE: "RESPONSE",
|
|
471
|
+
};
|
|
468
472
|
export var ChatOutputStream;
|
|
469
473
|
(function (ChatOutputStream) {
|
|
470
474
|
ChatOutputStream.visit = (value, visitor) => {
|
|
@@ -542,6 +546,10 @@ export const DocumentStatus = {
|
|
|
542
546
|
RECEIVED: "RECEIVED",
|
|
543
547
|
UPDATED: "UPDATED",
|
|
544
548
|
};
|
|
549
|
+
export const HallucinationReductionControl = {
|
|
550
|
+
DISABLED: "DISABLED",
|
|
551
|
+
ENABLED: "ENABLED",
|
|
552
|
+
};
|
|
545
553
|
export const ResponseScope = {
|
|
546
554
|
ENTERPRISE_CONTENT_ONLY: "ENTERPRISE_CONTENT_ONLY",
|
|
547
555
|
EXTENDED_KNOWLEDGE_ENABLED: "EXTENDED_KNOWLEDGE_ENABLED",
|
|
@@ -579,10 +587,6 @@ export class MediaTooLargeException extends __BaseException {
|
|
|
579
587
|
Object.setPrototypeOf(this, MediaTooLargeException.prototype);
|
|
580
588
|
}
|
|
581
589
|
}
|
|
582
|
-
export const MessageType = {
|
|
583
|
-
SYSTEM: "SYSTEM",
|
|
584
|
-
USER: "USER",
|
|
585
|
-
};
|
|
586
590
|
export const APISchemaFilterSensitiveLog = (obj) => {
|
|
587
591
|
if (obj.payload !== undefined)
|
|
588
592
|
return { payload: SENSITIVE_STRING };
|
|
@@ -113,6 +113,21 @@ export const se_ChatSyncCommand = async (input, context) => {
|
|
|
113
113
|
b.m("POST").h(headers).q(query).b(body);
|
|
114
114
|
return b.build();
|
|
115
115
|
};
|
|
116
|
+
export const se_CheckDocumentAccessCommand = async (input, context) => {
|
|
117
|
+
const b = rb(input, context);
|
|
118
|
+
const headers = {};
|
|
119
|
+
b.bp("/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access");
|
|
120
|
+
b.p("applicationId", () => input.applicationId, "{applicationId}", false);
|
|
121
|
+
b.p("indexId", () => input.indexId, "{indexId}", false);
|
|
122
|
+
b.p("userId", () => input.userId, "{userId}", false);
|
|
123
|
+
b.p("documentId", () => input.documentId, "{documentId}", false);
|
|
124
|
+
const query = map({
|
|
125
|
+
[_dSI]: [, input[_dSI]],
|
|
126
|
+
});
|
|
127
|
+
let body;
|
|
128
|
+
b.m("GET").h(headers).q(query).b(body);
|
|
129
|
+
return b.build();
|
|
130
|
+
};
|
|
116
131
|
export const se_CreateApplicationCommand = async (input, context) => {
|
|
117
132
|
const b = rb(input, context);
|
|
118
133
|
const headers = {
|
|
@@ -949,6 +964,7 @@ export const se_UpdateChatControlsConfigurationCommand = async (input, context)
|
|
|
949
964
|
blockedPhrasesConfigurationUpdate: (_) => _json(_),
|
|
950
965
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
951
966
|
creatorModeConfiguration: (_) => _json(_),
|
|
967
|
+
hallucinationReductionConfiguration: (_) => _json(_),
|
|
952
968
|
orchestrationConfiguration: (_) => _json(_),
|
|
953
969
|
responseScope: [],
|
|
954
970
|
topicConfigurationsToCreateOrUpdate: (_) => _json(_),
|
|
@@ -1195,6 +1211,23 @@ export const de_ChatSyncCommand = async (output, context) => {
|
|
|
1195
1211
|
Object.assign(contents, doc);
|
|
1196
1212
|
return contents;
|
|
1197
1213
|
};
|
|
1214
|
+
export const de_CheckDocumentAccessCommand = async (output, context) => {
|
|
1215
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1216
|
+
return de_CommandError(output, context);
|
|
1217
|
+
}
|
|
1218
|
+
const contents = map({
|
|
1219
|
+
$metadata: deserializeMetadata(output),
|
|
1220
|
+
});
|
|
1221
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
1222
|
+
const doc = take(data, {
|
|
1223
|
+
documentAcl: _json,
|
|
1224
|
+
hasAccess: __expectBoolean,
|
|
1225
|
+
userAliases: _json,
|
|
1226
|
+
userGroups: _json,
|
|
1227
|
+
});
|
|
1228
|
+
Object.assign(contents, doc);
|
|
1229
|
+
return contents;
|
|
1230
|
+
};
|
|
1198
1231
|
export const de_CreateApplicationCommand = async (output, context) => {
|
|
1199
1232
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1200
1233
|
return de_CommandError(output, context);
|
|
@@ -1502,6 +1535,7 @@ export const de_GetChatControlsConfigurationCommand = async (output, context) =>
|
|
|
1502
1535
|
const doc = take(data, {
|
|
1503
1536
|
blockedPhrases: _json,
|
|
1504
1537
|
creatorModeConfiguration: _json,
|
|
1538
|
+
hallucinationReductionConfiguration: _json,
|
|
1505
1539
|
nextToken: __expectString,
|
|
1506
1540
|
orchestrationConfiguration: _json,
|
|
1507
1541
|
responseScope: __expectString,
|
|
@@ -5,6 +5,7 @@ import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./c
|
|
|
5
5
|
import { CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput } from "./commands/CancelSubscriptionCommand";
|
|
6
6
|
import { ChatCommandInput, ChatCommandOutput } from "./commands/ChatCommand";
|
|
7
7
|
import { ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
|
|
8
|
+
import { CheckDocumentAccessCommandInput, CheckDocumentAccessCommandOutput } from "./commands/CheckDocumentAccessCommand";
|
|
8
9
|
import { CreateApplicationCommandInput, CreateApplicationCommandOutput } from "./commands/CreateApplicationCommand";
|
|
9
10
|
import { CreateDataAccessorCommandInput, CreateDataAccessorCommandOutput } from "./commands/CreateDataAccessorCommand";
|
|
10
11
|
import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
|
|
@@ -112,6 +113,12 @@ export interface QBusiness {
|
|
|
112
113
|
chatSync(args: ChatSyncCommandInput, options?: __HttpHandlerOptions): Promise<ChatSyncCommandOutput>;
|
|
113
114
|
chatSync(args: ChatSyncCommandInput, cb: (err: any, data?: ChatSyncCommandOutput) => void): void;
|
|
114
115
|
chatSync(args: ChatSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChatSyncCommandOutput) => void): void;
|
|
116
|
+
/**
|
|
117
|
+
* @see {@link CheckDocumentAccessCommand}
|
|
118
|
+
*/
|
|
119
|
+
checkDocumentAccess(args: CheckDocumentAccessCommandInput, options?: __HttpHandlerOptions): Promise<CheckDocumentAccessCommandOutput>;
|
|
120
|
+
checkDocumentAccess(args: CheckDocumentAccessCommandInput, cb: (err: any, data?: CheckDocumentAccessCommandOutput) => void): void;
|
|
121
|
+
checkDocumentAccess(args: CheckDocumentAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckDocumentAccessCommandOutput) => void): void;
|
|
115
122
|
/**
|
|
116
123
|
* @see {@link CreateApplicationCommand}
|
|
117
124
|
*/
|
|
@@ -530,45 +537,7 @@ export interface QBusiness {
|
|
|
530
537
|
updateWebExperience(args: UpdateWebExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebExperienceCommandOutput) => void): void;
|
|
531
538
|
}
|
|
532
539
|
/**
|
|
533
|
-
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
534
|
-
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
|
|
535
|
-
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
|
|
536
|
-
* as question-answering, knowledge discovery, writing email messages, summarizing text,
|
|
537
|
-
* drafting document outlines, and brainstorming ideas. Users ask questions of
|
|
538
|
-
* Amazon Q Business and get answers that are presented in a conversational manner. For an
|
|
539
|
-
* introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
|
|
540
|
-
* <i>Amazon Q Business User Guide</i>
|
|
541
|
-
* </a>.</p>
|
|
542
|
-
* <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>
|
|
543
|
-
* <p>For information about the IAM access control permissions you need to
|
|
544
|
-
* 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
|
|
545
|
-
* <i>Amazon Q Business User Guide</i>.</p>
|
|
546
|
-
* <p>The following resources provide additional information about using the Amazon Q Business
|
|
547
|
-
* API:</p>
|
|
548
|
-
* <ul>
|
|
549
|
-
* <li>
|
|
550
|
-
* <p>
|
|
551
|
-
* <i>
|
|
552
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
|
|
553
|
-
* Amazon Q Business</a>
|
|
554
|
-
* </i>
|
|
555
|
-
* </p>
|
|
556
|
-
* </li>
|
|
557
|
-
* <li>
|
|
558
|
-
* <p>
|
|
559
|
-
* <i>
|
|
560
|
-
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
|
|
561
|
-
* </i>
|
|
562
|
-
* </p>
|
|
563
|
-
* </li>
|
|
564
|
-
* <li>
|
|
565
|
-
* <p>
|
|
566
|
-
* <i>
|
|
567
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
|
|
568
|
-
* </i>
|
|
569
|
-
* </p>
|
|
570
|
-
* </li>
|
|
571
|
-
* </ul>
|
|
540
|
+
* <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 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 Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <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 Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
|
|
572
541
|
* @public
|
|
573
542
|
*/
|
|
574
543
|
export declare class QBusiness extends QBusinessClient implements QBusiness {
|
|
@@ -16,6 +16,7 @@ import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./c
|
|
|
16
16
|
import { CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput } from "./commands/CancelSubscriptionCommand";
|
|
17
17
|
import { ChatCommandInput, ChatCommandOutput } from "./commands/ChatCommand";
|
|
18
18
|
import { ChatSyncCommandInput, ChatSyncCommandOutput } from "./commands/ChatSyncCommand";
|
|
19
|
+
import { CheckDocumentAccessCommandInput, CheckDocumentAccessCommandOutput } from "./commands/CheckDocumentAccessCommand";
|
|
19
20
|
import { CreateApplicationCommandInput, CreateApplicationCommandOutput } from "./commands/CreateApplicationCommand";
|
|
20
21
|
import { CreateDataAccessorCommandInput, CreateDataAccessorCommandOutput } from "./commands/CreateDataAccessorCommand";
|
|
21
22
|
import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
|
|
@@ -91,11 +92,11 @@ export { __Client };
|
|
|
91
92
|
/**
|
|
92
93
|
* @public
|
|
93
94
|
*/
|
|
94
|
-
export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CreateApplicationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
|
|
95
|
+
export type ServiceInputTypes = AssociatePermissionCommandInput | BatchDeleteDocumentCommandInput | BatchPutDocumentCommandInput | CancelSubscriptionCommandInput | ChatCommandInput | ChatSyncCommandInput | CheckDocumentAccessCommandInput | CreateApplicationCommandInput | CreateDataAccessorCommandInput | CreateDataSourceCommandInput | CreateIndexCommandInput | CreatePluginCommandInput | CreateRetrieverCommandInput | CreateSubscriptionCommandInput | CreateUserCommandInput | CreateWebExperienceCommandInput | DeleteApplicationCommandInput | DeleteAttachmentCommandInput | DeleteChatControlsConfigurationCommandInput | DeleteConversationCommandInput | DeleteDataAccessorCommandInput | DeleteDataSourceCommandInput | DeleteGroupCommandInput | DeleteIndexCommandInput | DeletePluginCommandInput | DeleteRetrieverCommandInput | DeleteUserCommandInput | DeleteWebExperienceCommandInput | DisassociatePermissionCommandInput | GetApplicationCommandInput | GetChatControlsConfigurationCommandInput | GetDataAccessorCommandInput | GetDataSourceCommandInput | GetGroupCommandInput | GetIndexCommandInput | GetMediaCommandInput | GetPluginCommandInput | GetPolicyCommandInput | GetRetrieverCommandInput | GetUserCommandInput | GetWebExperienceCommandInput | ListApplicationsCommandInput | ListAttachmentsCommandInput | ListConversationsCommandInput | ListDataAccessorsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListGroupsCommandInput | ListIndicesCommandInput | ListMessagesCommandInput | ListPluginActionsCommandInput | ListPluginTypeActionsCommandInput | ListPluginTypeMetadataCommandInput | ListPluginsCommandInput | ListRetrieversCommandInput | ListSubscriptionsCommandInput | ListTagsForResourceCommandInput | ListWebExperiencesCommandInput | PutFeedbackCommandInput | PutGroupCommandInput | SearchRelevantContentCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateApplicationCommandInput | UpdateChatControlsConfigurationCommandInput | UpdateDataAccessorCommandInput | UpdateDataSourceCommandInput | UpdateIndexCommandInput | UpdatePluginCommandInput | UpdateRetrieverCommandInput | UpdateSubscriptionCommandInput | UpdateUserCommandInput | UpdateWebExperienceCommandInput;
|
|
95
96
|
/**
|
|
96
97
|
* @public
|
|
97
98
|
*/
|
|
98
|
-
export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CreateApplicationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
|
|
99
|
+
export type ServiceOutputTypes = AssociatePermissionCommandOutput | BatchDeleteDocumentCommandOutput | BatchPutDocumentCommandOutput | CancelSubscriptionCommandOutput | ChatCommandOutput | ChatSyncCommandOutput | CheckDocumentAccessCommandOutput | CreateApplicationCommandOutput | CreateDataAccessorCommandOutput | CreateDataSourceCommandOutput | CreateIndexCommandOutput | CreatePluginCommandOutput | CreateRetrieverCommandOutput | CreateSubscriptionCommandOutput | CreateUserCommandOutput | CreateWebExperienceCommandOutput | DeleteApplicationCommandOutput | DeleteAttachmentCommandOutput | DeleteChatControlsConfigurationCommandOutput | DeleteConversationCommandOutput | DeleteDataAccessorCommandOutput | DeleteDataSourceCommandOutput | DeleteGroupCommandOutput | DeleteIndexCommandOutput | DeletePluginCommandOutput | DeleteRetrieverCommandOutput | DeleteUserCommandOutput | DeleteWebExperienceCommandOutput | DisassociatePermissionCommandOutput | GetApplicationCommandOutput | GetChatControlsConfigurationCommandOutput | GetDataAccessorCommandOutput | GetDataSourceCommandOutput | GetGroupCommandOutput | GetIndexCommandOutput | GetMediaCommandOutput | GetPluginCommandOutput | GetPolicyCommandOutput | GetRetrieverCommandOutput | GetUserCommandOutput | GetWebExperienceCommandOutput | ListApplicationsCommandOutput | ListAttachmentsCommandOutput | ListConversationsCommandOutput | ListDataAccessorsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListGroupsCommandOutput | ListIndicesCommandOutput | ListMessagesCommandOutput | ListPluginActionsCommandOutput | ListPluginTypeActionsCommandOutput | ListPluginTypeMetadataCommandOutput | ListPluginsCommandOutput | ListRetrieversCommandOutput | ListSubscriptionsCommandOutput | ListTagsForResourceCommandOutput | ListWebExperiencesCommandOutput | PutFeedbackCommandOutput | PutGroupCommandOutput | SearchRelevantContentCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateApplicationCommandOutput | UpdateChatControlsConfigurationCommandOutput | UpdateDataAccessorCommandOutput | UpdateDataSourceCommandOutput | UpdateIndexCommandOutput | UpdatePluginCommandOutput | UpdateRetrieverCommandOutput | UpdateSubscriptionCommandOutput | UpdateUserCommandOutput | UpdateWebExperienceCommandOutput;
|
|
99
100
|
/**
|
|
100
101
|
* @public
|
|
101
102
|
*/
|
|
@@ -256,45 +257,7 @@ export type QBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__
|
|
|
256
257
|
export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedConfigType {
|
|
257
258
|
}
|
|
258
259
|
/**
|
|
259
|
-
* <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
|
|
260
|
-
* managed, generative-AI powered enterprise chat assistant that you can deploy within your
|
|
261
|
-
* organization. Amazon Q Business enhances employee productivity by supporting key tasks such
|
|
262
|
-
* as question-answering, knowledge discovery, writing email messages, summarizing text,
|
|
263
|
-
* drafting document outlines, and brainstorming ideas. Users ask questions of
|
|
264
|
-
* Amazon Q Business and get answers that are presented in a conversational manner. For an
|
|
265
|
-
* introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
|
|
266
|
-
* <i>Amazon Q Business User Guide</i>
|
|
267
|
-
* </a>.</p>
|
|
268
|
-
* <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>
|
|
269
|
-
* <p>For information about the IAM access control permissions you need to
|
|
270
|
-
* 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
|
|
271
|
-
* <i>Amazon Q Business User Guide</i>.</p>
|
|
272
|
-
* <p>The following resources provide additional information about using the Amazon Q Business
|
|
273
|
-
* API:</p>
|
|
274
|
-
* <ul>
|
|
275
|
-
* <li>
|
|
276
|
-
* <p>
|
|
277
|
-
* <i>
|
|
278
|
-
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
|
|
279
|
-
* Amazon Q Business</a>
|
|
280
|
-
* </i>
|
|
281
|
-
* </p>
|
|
282
|
-
* </li>
|
|
283
|
-
* <li>
|
|
284
|
-
* <p>
|
|
285
|
-
* <i>
|
|
286
|
-
* <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
|
|
287
|
-
* </i>
|
|
288
|
-
* </p>
|
|
289
|
-
* </li>
|
|
290
|
-
* <li>
|
|
291
|
-
* <p>
|
|
292
|
-
* <i>
|
|
293
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a>
|
|
294
|
-
* </i>
|
|
295
|
-
* </p>
|
|
296
|
-
* </li>
|
|
297
|
-
* </ul>
|
|
260
|
+
* <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 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 Business</a> in the <i>Amazon Q Business User Guide</i>.</p> <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 Business</a> </i> </p> </li> <li> <p> <i> <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a> </i> </p> </li> <li> <p> <i> <a href="https://docs.aws.amazon.com/general/latest/gr/amazonq.html">Amazon Web Services General Reference</a> </i> </p> </li> </ul>
|
|
298
261
|
* @public
|
|
299
262
|
*/
|
|
300
263
|
export declare class QBusinessClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, QBusinessClientResolvedConfig> {
|
|
@@ -27,9 +27,7 @@ declare const AssociatePermissionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV.
|
|
31
|
-
* This operation creates a new policy statement for the specified Amazon Q Business application.
|
|
32
|
-
* The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.</p>
|
|
30
|
+
* <p>Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -59,31 +57,25 @@ declare const AssociatePermissionCommand_base: {
|
|
|
59
57
|
* @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
|
|
60
58
|
*
|
|
61
59
|
* @throws {@link AccessDeniedException} (client fault)
|
|
62
|
-
* <p> You don't have access to perform this action. Make sure you have the required
|
|
63
|
-
* permission policies and user accounts and try again.</p>
|
|
60
|
+
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
64
61
|
*
|
|
65
62
|
* @throws {@link ConflictException} (client fault)
|
|
66
|
-
* <p>You are trying to perform an action that conflicts with the current status of your
|
|
67
|
-
* resource. Fix any inconsistencies with your resources and try again.</p>
|
|
63
|
+
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
68
64
|
*
|
|
69
65
|
* @throws {@link InternalServerException} (server fault)
|
|
70
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
71
|
-
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
66
|
+
* <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>
|
|
72
67
|
*
|
|
73
68
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
|
|
75
|
-
* provided the correct resource and try again.</p>
|
|
69
|
+
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
76
70
|
*
|
|
77
71
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
72
|
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
79
73
|
*
|
|
80
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try
|
|
82
|
-
* again.</p>
|
|
75
|
+
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
83
76
|
*
|
|
84
77
|
* @throws {@link ValidationException} (client fault)
|
|
85
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
86
|
-
* correct input and try again.</p>
|
|
78
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
87
79
|
*
|
|
88
80
|
* @throws {@link QBusinessServiceException}
|
|
89
81
|
* <p>Base exception class for all service exceptions from QBusiness service.</p>
|