@aws-sdk/client-qbusiness 3.787.0 → 3.796.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.
Files changed (103) hide show
  1. package/README.md +9 -39
  2. package/dist-cjs/index.js +55 -5
  3. package/dist-es/QBusiness.js +2 -0
  4. package/dist-es/commands/CheckDocumentAccessCommand.js +22 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_0.js +0 -4
  7. package/dist-es/models/models_1.js +4 -0
  8. package/dist-es/protocols/Aws_restJson1.js +32 -0
  9. package/dist-types/QBusiness.d.ts +8 -39
  10. package/dist-types/QBusinessClient.d.ts +4 -41
  11. package/dist-types/commands/AssociatePermissionCommand.d.ts +7 -15
  12. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +7 -16
  13. package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -29
  14. package/dist-types/commands/CancelSubscriptionCommand.d.ts +6 -13
  15. package/dist-types/commands/ChatCommand.d.ts +8 -17
  16. package/dist-types/commands/ChatSyncCommand.d.ts +8 -17
  17. package/dist-types/commands/CheckDocumentAccessCommand.d.ts +145 -0
  18. package/dist-types/commands/CreateApplicationCommand.d.ts +7 -27
  19. package/dist-types/commands/CreateDataAccessorCommand.d.ts +7 -18
  20. package/dist-types/commands/CreateDataSourceCommand.d.ts +7 -16
  21. package/dist-types/commands/CreateIndexCommand.d.ts +7 -21
  22. package/dist-types/commands/CreatePluginCommand.d.ts +6 -12
  23. package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -12
  24. package/dist-types/commands/CreateSubscriptionCommand.d.ts +7 -18
  25. package/dist-types/commands/CreateUserCommand.d.ts +7 -14
  26. package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -12
  27. package/dist-types/commands/DeleteApplicationCommand.d.ts +6 -12
  28. package/dist-types/commands/DeleteAttachmentCommand.d.ts +6 -12
  29. package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +5 -10
  30. package/dist-types/commands/DeleteConversationCommand.d.ts +6 -12
  31. package/dist-types/commands/DeleteDataAccessorCommand.d.ts +7 -14
  32. package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -15
  33. package/dist-types/commands/DeleteGroupCommand.d.ts +7 -21
  34. package/dist-types/commands/DeleteIndexCommand.d.ts +6 -12
  35. package/dist-types/commands/DeletePluginCommand.d.ts +6 -12
  36. package/dist-types/commands/DeleteRetrieverCommand.d.ts +6 -12
  37. package/dist-types/commands/DeleteUserCommand.d.ts +6 -12
  38. package/dist-types/commands/DeleteWebExperienceCommand.d.ts +6 -12
  39. package/dist-types/commands/DisassociatePermissionCommand.d.ts +7 -14
  40. package/dist-types/commands/GetApplicationCommand.d.ts +5 -10
  41. package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +6 -12
  42. package/dist-types/commands/GetDataAccessorCommand.d.ts +6 -14
  43. package/dist-types/commands/GetDataSourceCommand.d.ts +5 -10
  44. package/dist-types/commands/GetGroupCommand.d.ts +6 -12
  45. package/dist-types/commands/GetIndexCommand.d.ts +5 -10
  46. package/dist-types/commands/GetMediaCommand.d.ts +7 -16
  47. package/dist-types/commands/GetPluginCommand.d.ts +5 -10
  48. package/dist-types/commands/GetPolicyCommand.d.ts +6 -12
  49. package/dist-types/commands/GetRetrieverCommand.d.ts +6 -12
  50. package/dist-types/commands/GetUserCommand.d.ts +7 -14
  51. package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -10
  52. package/dist-types/commands/ListApplicationsCommand.d.ts +5 -15
  53. package/dist-types/commands/ListAttachmentsCommand.d.ts +6 -12
  54. package/dist-types/commands/ListConversationsCommand.d.ts +6 -12
  55. package/dist-types/commands/ListDataAccessorsCommand.d.ts +6 -13
  56. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -12
  57. package/dist-types/commands/ListDataSourcesCommand.d.ts +5 -10
  58. package/dist-types/commands/ListDocumentsCommand.d.ts +7 -11
  59. package/dist-types/commands/ListGroupsCommand.d.ts +7 -13
  60. package/dist-types/commands/ListIndicesCommand.d.ts +5 -10
  61. package/dist-types/commands/ListMessagesCommand.d.ts +7 -13
  62. package/dist-types/commands/ListPluginActionsCommand.d.ts +6 -12
  63. package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +5 -10
  64. package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +4 -8
  65. package/dist-types/commands/ListPluginsCommand.d.ts +5 -10
  66. package/dist-types/commands/ListRetrieversCommand.d.ts +5 -10
  67. package/dist-types/commands/ListSubscriptionsCommand.d.ts +6 -12
  68. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -12
  69. package/dist-types/commands/ListWebExperiencesCommand.d.ts +5 -10
  70. package/dist-types/commands/PutFeedbackCommand.d.ts +6 -12
  71. package/dist-types/commands/PutGroupCommand.d.ts +7 -23
  72. package/dist-types/commands/SearchRelevantContentCommand.d.ts +7 -18
  73. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +7 -14
  74. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -14
  75. package/dist-types/commands/TagResourceCommand.d.ts +7 -15
  76. package/dist-types/commands/UntagResourceCommand.d.ts +5 -10
  77. package/dist-types/commands/UpdateApplicationCommand.d.ts +7 -25
  78. package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +7 -14
  79. package/dist-types/commands/UpdateDataAccessorCommand.d.ts +7 -15
  80. package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -12
  81. package/dist-types/commands/UpdateIndexCommand.d.ts +6 -12
  82. package/dist-types/commands/UpdatePluginCommand.d.ts +6 -12
  83. package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -12
  84. package/dist-types/commands/UpdateSubscriptionCommand.d.ts +7 -16
  85. package/dist-types/commands/UpdateUserCommand.d.ts +6 -12
  86. package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -12
  87. package/dist-types/commands/index.d.ts +1 -0
  88. package/dist-types/index.d.ts +1 -39
  89. package/dist-types/models/models_0.d.ts +500 -1228
  90. package/dist-types/models/models_1.d.ts +257 -181
  91. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  92. package/dist-types/ts3.4/QBusiness.d.ts +17 -0
  93. package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
  94. package/dist-types/ts3.4/commands/CheckDocumentAccessCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +2 -4
  96. package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +4 -2
  99. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  100. package/dist-types/ts3.4/models/models_0.d.ts +42 -51
  101. package/dist-types/ts3.4/models/models_1.d.ts +55 -0
  102. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  103. package/package.json +5 -5
@@ -27,9 +27,7 @@ declare const CancelSubscriptionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Unsubscribes a user or a group from their pricing tier in an Amazon Q Business
31
- * application. An unsubscribed user or group loses all Amazon Q Business feature access at the
32
- * start of next month. </p>
30
+ * <p>Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -61,24 +59,19 @@ declare const CancelSubscriptionCommand_base: {
61
59
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
62
60
  *
63
61
  * @throws {@link AccessDeniedException} (client fault)
64
- * <p> You don't have access to perform this action. Make sure you have the required
65
- * permission policies and user accounts and try again.</p>
62
+ * <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>
66
63
  *
67
64
  * @throws {@link InternalServerException} (server fault)
68
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
69
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
65
+ * <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>
70
66
  *
71
67
  * @throws {@link ResourceNotFoundException} (client fault)
72
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
73
- * provided the correct resource and try again.</p>
68
+ * <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>
74
69
  *
75
70
  * @throws {@link ThrottlingException} (client fault)
76
- * <p>The request was denied due to throttling. Reduce the number of requests and try
77
- * again.</p>
71
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
78
72
  *
79
73
  * @throws {@link ValidationException} (client fault)
80
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
81
- * correct input and try again.</p>
74
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
82
75
  *
83
76
  * @throws {@link QBusinessServiceException}
84
77
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -279,37 +279,28 @@ declare const ChatCommand_base: {
279
279
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
280
280
  *
281
281
  * @throws {@link AccessDeniedException} (client fault)
282
- * <p> You don't have access to perform this action. Make sure you have the required
283
- * permission policies and user accounts and try again.</p>
282
+ * <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>
284
283
  *
285
284
  * @throws {@link ConflictException} (client fault)
286
- * <p>You are trying to perform an action that conflicts with the current status of your
287
- * resource. Fix any inconsistencies with your resources and try again.</p>
285
+ * <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>
288
286
  *
289
287
  * @throws {@link ExternalResourceException} (client fault)
290
- * <p>An external resource that you configured with your application is returning errors and
291
- * preventing this operation from succeeding. Fix those errors and try again.
292
- * </p>
288
+ * <p>An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again. </p>
293
289
  *
294
290
  * @throws {@link InternalServerException} (server fault)
295
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
296
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
291
+ * <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>
297
292
  *
298
293
  * @throws {@link LicenseNotFoundException} (client fault)
299
- * <p>You don't have permissions to perform the action because your license is inactive. Ask
300
- * your admin to activate your license and try again after your licence is active.</p>
294
+ * <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
301
295
  *
302
296
  * @throws {@link ResourceNotFoundException} (client fault)
303
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
304
- * provided the correct resource and try again.</p>
297
+ * <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>
305
298
  *
306
299
  * @throws {@link ThrottlingException} (client fault)
307
- * <p>The request was denied due to throttling. Reduce the number of requests and try
308
- * again.</p>
300
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
309
301
  *
310
302
  * @throws {@link ValidationException} (client fault)
311
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
312
- * correct input and try again.</p>
303
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
313
304
  *
314
305
  * @throws {@link QBusinessServiceException}
315
306
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -255,37 +255,28 @@ declare const ChatSyncCommand_base: {
255
255
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
256
256
  *
257
257
  * @throws {@link AccessDeniedException} (client fault)
258
- * <p> You don't have access to perform this action. Make sure you have the required
259
- * permission policies and user accounts and try again.</p>
258
+ * <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>
260
259
  *
261
260
  * @throws {@link ConflictException} (client fault)
262
- * <p>You are trying to perform an action that conflicts with the current status of your
263
- * resource. Fix any inconsistencies with your resources and try again.</p>
261
+ * <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>
264
262
  *
265
263
  * @throws {@link ExternalResourceException} (client fault)
266
- * <p>An external resource that you configured with your application is returning errors and
267
- * preventing this operation from succeeding. Fix those errors and try again.
268
- * </p>
264
+ * <p>An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again. </p>
269
265
  *
270
266
  * @throws {@link InternalServerException} (server fault)
271
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
272
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
267
+ * <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>
273
268
  *
274
269
  * @throws {@link LicenseNotFoundException} (client fault)
275
- * <p>You don't have permissions to perform the action because your license is inactive. Ask
276
- * your admin to activate your license and try again after your licence is active.</p>
270
+ * <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
277
271
  *
278
272
  * @throws {@link ResourceNotFoundException} (client fault)
279
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
280
- * provided the correct resource and try again.</p>
273
+ * <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>
281
274
  *
282
275
  * @throws {@link ThrottlingException} (client fault)
283
- * <p>The request was denied due to throttling. Reduce the number of requests and try
284
- * again.</p>
276
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
285
277
  *
286
278
  * @throws {@link ValidationException} (client fault)
287
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
288
- * correct input and try again.</p>
279
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
289
280
  *
290
281
  * @throws {@link QBusinessServiceException}
291
282
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -0,0 +1,145 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CheckDocumentAccessRequest, CheckDocumentAccessResponse } from "../models/models_0";
4
+ import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CheckDocumentAccessCommand}.
14
+ */
15
+ export interface CheckDocumentAccessCommandInput extends CheckDocumentAccessRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CheckDocumentAccessCommand}.
21
+ */
22
+ export interface CheckDocumentAccessCommandOutput extends CheckDocumentAccessResponse, __MetadataBearer {
23
+ }
24
+ declare const CheckDocumentAccessCommand_base: {
25
+ new (input: CheckDocumentAccessCommandInput): import("@smithy/smithy-client").CommandImpl<CheckDocumentAccessCommandInput, CheckDocumentAccessCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CheckDocumentAccessCommandInput): import("@smithy/smithy-client").CommandImpl<CheckDocumentAccessCommandInput, CheckDocumentAccessCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QBusinessClient, CheckDocumentAccessCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
35
+ * // const { QBusinessClient, CheckDocumentAccessCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
36
+ * const client = new QBusinessClient(config);
37
+ * const input = { // CheckDocumentAccessRequest
38
+ * applicationId: "STRING_VALUE", // required
39
+ * indexId: "STRING_VALUE", // required
40
+ * userId: "STRING_VALUE", // required
41
+ * documentId: "STRING_VALUE", // required
42
+ * dataSourceId: "STRING_VALUE",
43
+ * };
44
+ * const command = new CheckDocumentAccessCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // CheckDocumentAccessResponse
47
+ * // userGroups: [ // AssociatedGroups
48
+ * // { // AssociatedGroup
49
+ * // name: "STRING_VALUE",
50
+ * // type: "INDEX" || "DATASOURCE",
51
+ * // },
52
+ * // ],
53
+ * // userAliases: [ // AssociatedUsers
54
+ * // { // AssociatedUser
55
+ * // id: "STRING_VALUE",
56
+ * // type: "INDEX" || "DATASOURCE",
57
+ * // },
58
+ * // ],
59
+ * // hasAccess: true || false,
60
+ * // documentAcl: { // DocumentAcl
61
+ * // allowlist: { // DocumentAclMembership
62
+ * // memberRelation: "AND" || "OR",
63
+ * // conditions: [ // DocumentAclConditions
64
+ * // { // DocumentAclCondition
65
+ * // memberRelation: "AND" || "OR",
66
+ * // users: [ // DocumentAclUsers
67
+ * // { // DocumentAclUser
68
+ * // id: "STRING_VALUE",
69
+ * // type: "INDEX" || "DATASOURCE",
70
+ * // },
71
+ * // ],
72
+ * // groups: [ // DocumentAclGroups
73
+ * // { // DocumentAclGroup
74
+ * // name: "STRING_VALUE",
75
+ * // type: "INDEX" || "DATASOURCE",
76
+ * // },
77
+ * // ],
78
+ * // },
79
+ * // ],
80
+ * // },
81
+ * // denyList: {
82
+ * // memberRelation: "AND" || "OR",
83
+ * // conditions: [
84
+ * // {
85
+ * // memberRelation: "AND" || "OR",
86
+ * // users: [
87
+ * // {
88
+ * // id: "STRING_VALUE",
89
+ * // type: "INDEX" || "DATASOURCE",
90
+ * // },
91
+ * // ],
92
+ * // groups: [
93
+ * // {
94
+ * // name: "STRING_VALUE",
95
+ * // type: "INDEX" || "DATASOURCE",
96
+ * // },
97
+ * // ],
98
+ * // },
99
+ * // ],
100
+ * // },
101
+ * // },
102
+ * // };
103
+ *
104
+ * ```
105
+ *
106
+ * @param CheckDocumentAccessCommandInput - {@link CheckDocumentAccessCommandInput}
107
+ * @returns {@link CheckDocumentAccessCommandOutput}
108
+ * @see {@link CheckDocumentAccessCommandInput} for command's `input` shape.
109
+ * @see {@link CheckDocumentAccessCommandOutput} for command's `response` shape.
110
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
111
+ *
112
+ * @throws {@link AccessDeniedException} (client fault)
113
+ * <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>
114
+ *
115
+ * @throws {@link InternalServerException} (server fault)
116
+ * <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>
117
+ *
118
+ * @throws {@link ResourceNotFoundException} (client fault)
119
+ * <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>
120
+ *
121
+ * @throws {@link ThrottlingException} (client fault)
122
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
123
+ *
124
+ * @throws {@link ValidationException} (client fault)
125
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
126
+ *
127
+ * @throws {@link QBusinessServiceException}
128
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
129
+ *
130
+ *
131
+ * @public
132
+ */
133
+ export declare class CheckDocumentAccessCommand extends CheckDocumentAccessCommand_base {
134
+ /** @internal type navigation helper, not in runtime. */
135
+ protected static __types: {
136
+ api: {
137
+ input: CheckDocumentAccessRequest;
138
+ output: CheckDocumentAccessResponse;
139
+ };
140
+ sdk: {
141
+ input: CheckDocumentAccessCommandInput;
142
+ output: CheckDocumentAccessCommandOutput;
143
+ };
144
+ };
145
+ }
@@ -27,21 +27,7 @@ declare const CreateApplicationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an Amazon Q Business application.</p>
31
- * <note>
32
- * <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
33
- * also available in Amazon Q Business Lite. For information on what's included in
34
- * Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign
35
- * subscription tiers to users. </p>
36
- * <p>An Amazon Q Apps service linked role will be created if it's absent in the
37
- * Amazon Web Services account when <code>QAppsConfiguration</code> is enabled in
38
- * the request. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html"> Using
39
- * service-linked roles for Q Apps</a>.</p>
40
- * <p>When you create an application, Amazon Q Business may securely transmit data for
41
- * processing from your selected Amazon Web Services region, but within your geography.
42
- * For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html">Cross region
43
- * inference in Amazon Q Business</a>.</p>
44
- * </note>
30
+ * <p>Creates an Amazon Q Business application.</p> <note> <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign subscription tiers to users. </p> <p>An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when <code>QAppsConfiguration</code> is enabled in the request. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html"> Using service-linked roles for Q Apps</a>.</p> <p>When you create an application, Amazon Q Business may securely transmit data for processing from your selected Amazon Web Services region, but within your geography. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html">Cross region inference in Amazon Q Business</a>.</p> </note>
45
31
  * @example
46
32
  * Use a bare-bones client and the command you need to make an API call.
47
33
  * ```javascript
@@ -97,31 +83,25 @@ declare const CreateApplicationCommand_base: {
97
83
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
98
84
  *
99
85
  * @throws {@link AccessDeniedException} (client fault)
100
- * <p> You don't have access to perform this action. Make sure you have the required
101
- * permission policies and user accounts and try again.</p>
86
+ * <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>
102
87
  *
103
88
  * @throws {@link ConflictException} (client fault)
104
- * <p>You are trying to perform an action that conflicts with the current status of your
105
- * resource. Fix any inconsistencies with your resources and try again.</p>
89
+ * <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>
106
90
  *
107
91
  * @throws {@link InternalServerException} (server fault)
108
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
109
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
92
+ * <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>
110
93
  *
111
94
  * @throws {@link ResourceNotFoundException} (client fault)
112
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
113
- * provided the correct resource and try again.</p>
95
+ * <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>
114
96
  *
115
97
  * @throws {@link ServiceQuotaExceededException} (client fault)
116
98
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
117
99
  *
118
100
  * @throws {@link ThrottlingException} (client fault)
119
- * <p>The request was denied due to throttling. Reduce the number of requests and try
120
- * again.</p>
101
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
121
102
  *
122
103
  * @throws {@link ValidationException} (client fault)
123
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
124
- * correct input and try again.</p>
104
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
125
105
  *
126
106
  * @throws {@link QBusinessServiceException}
127
107
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -28,12 +28,7 @@ declare const CreateDataAccessorCommand_base: {
28
28
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
29
  };
30
30
  /**
31
- * <p>Creates a new data accessor for an ISV to access data from a Amazon Q Business application.
32
- * The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data.
33
- * It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the
34
- * specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created,
35
- * an IAM Identity Center application is also created to manage the ISV's identity and authentication for
36
- * accessing the Amazon Q Business application.</p>
31
+ * <p>Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.</p>
37
32
  * @example
38
33
  * Use a bare-bones client and the command you need to make an API call.
39
34
  * ```javascript
@@ -157,31 +152,25 @@ declare const CreateDataAccessorCommand_base: {
157
152
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
158
153
  *
159
154
  * @throws {@link AccessDeniedException} (client fault)
160
- * <p> You don't have access to perform this action. Make sure you have the required
161
- * permission policies and user accounts and try again.</p>
155
+ * <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>
162
156
  *
163
157
  * @throws {@link ConflictException} (client fault)
164
- * <p>You are trying to perform an action that conflicts with the current status of your
165
- * resource. Fix any inconsistencies with your resources and try again.</p>
158
+ * <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>
166
159
  *
167
160
  * @throws {@link InternalServerException} (server fault)
168
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
169
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
161
+ * <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>
170
162
  *
171
163
  * @throws {@link ResourceNotFoundException} (client fault)
172
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
173
- * provided the correct resource and try again.</p>
164
+ * <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>
174
165
  *
175
166
  * @throws {@link ServiceQuotaExceededException} (client fault)
176
167
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
177
168
  *
178
169
  * @throws {@link ThrottlingException} (client fault)
179
- * <p>The request was denied due to throttling. Reduce the number of requests and try
180
- * again.</p>
170
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
181
171
  *
182
172
  * @throws {@link ValidationException} (client fault)
183
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
184
- * correct input and try again.</p>
173
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
185
174
  *
186
175
  * @throws {@link QBusinessServiceException}
187
176
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -27,10 +27,7 @@ declare const CreateDataSourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a data source connector for an Amazon Q Business application.</p>
31
- * <p>
32
- * <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if
33
- * the data source was successfully created. Otherwise, an exception is raised.</p>
30
+ * <p>Creates a data source connector for an Amazon Q Business application.</p> <p> <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -153,31 +150,25 @@ declare const CreateDataSourceCommand_base: {
153
150
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
154
151
  *
155
152
  * @throws {@link AccessDeniedException} (client fault)
156
- * <p> You don't have access to perform this action. Make sure you have the required
157
- * permission policies and user accounts and try again.</p>
153
+ * <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>
158
154
  *
159
155
  * @throws {@link ConflictException} (client fault)
160
- * <p>You are trying to perform an action that conflicts with the current status of your
161
- * resource. Fix any inconsistencies with your resources and try again.</p>
156
+ * <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>
162
157
  *
163
158
  * @throws {@link InternalServerException} (server fault)
164
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
165
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
159
+ * <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>
166
160
  *
167
161
  * @throws {@link ResourceNotFoundException} (client fault)
168
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
169
- * provided the correct resource and try again.</p>
162
+ * <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>
170
163
  *
171
164
  * @throws {@link ServiceQuotaExceededException} (client fault)
172
165
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
173
166
  *
174
167
  * @throws {@link ThrottlingException} (client fault)
175
- * <p>The request was denied due to throttling. Reduce the number of requests and try
176
- * again.</p>
168
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
177
169
  *
178
170
  * @throws {@link ValidationException} (client fault)
179
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
180
- * correct input and try again.</p>
171
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
181
172
  *
182
173
  * @throws {@link QBusinessServiceException}
183
174
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -27,15 +27,7 @@ declare const CreateIndexCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an Amazon Q Business index.</p>
31
- * <p>To determine if index creation has completed, check the <code>Status</code> field
32
- * returned from a call to <code>DescribeIndex</code>. The <code>Status</code> field is set
33
- * to <code>ACTIVE</code> when the index is ready to use.</p>
34
- * <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html">
35
- * <code>BatchPutDocument</code>
36
- * </a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html">
37
- * <code>CreateDataSource</code>
38
- * </a> API.</p>
30
+ * <p>Creates an Amazon Q Business index.</p> <p>To determine if index creation has completed, check the <code>Status</code> field returned from a call to <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when the index is ready to use.</p> <p>Once the index is active, you can index your documents using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html"> <code>BatchPutDocument</code> </a> API or the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html"> <code>CreateDataSource</code> </a> API.</p>
39
31
  * @example
40
32
  * Use a bare-bones client and the command you need to make an API call.
41
33
  * ```javascript
@@ -74,31 +66,25 @@ declare const CreateIndexCommand_base: {
74
66
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
75
67
  *
76
68
  * @throws {@link AccessDeniedException} (client fault)
77
- * <p> You don't have access to perform this action. Make sure you have the required
78
- * permission policies and user accounts and try again.</p>
69
+ * <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>
79
70
  *
80
71
  * @throws {@link ConflictException} (client fault)
81
- * <p>You are trying to perform an action that conflicts with the current status of your
82
- * resource. Fix any inconsistencies with your resources and try again.</p>
72
+ * <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>
83
73
  *
84
74
  * @throws {@link InternalServerException} (server fault)
85
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
86
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
75
+ * <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>
87
76
  *
88
77
  * @throws {@link ResourceNotFoundException} (client fault)
89
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
90
- * provided the correct resource and try again.</p>
78
+ * <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>
91
79
  *
92
80
  * @throws {@link ServiceQuotaExceededException} (client fault)
93
81
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
94
82
  *
95
83
  * @throws {@link ThrottlingException} (client fault)
96
- * <p>The request was denied due to throttling. Reduce the number of requests and try
97
- * again.</p>
84
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
98
85
  *
99
86
  * @throws {@link ValidationException} (client fault)
100
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
101
- * correct input and try again.</p>
87
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
102
88
  *
103
89
  * @throws {@link QBusinessServiceException}
104
90
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -92,31 +92,25 @@ declare const CreatePluginCommand_base: {
92
92
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
93
93
  *
94
94
  * @throws {@link AccessDeniedException} (client fault)
95
- * <p> You don't have access to perform this action. Make sure you have the required
96
- * permission policies and user accounts and try again.</p>
95
+ * <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>
97
96
  *
98
97
  * @throws {@link ConflictException} (client fault)
99
- * <p>You are trying to perform an action that conflicts with the current status of your
100
- * resource. Fix any inconsistencies with your resources and try again.</p>
98
+ * <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>
101
99
  *
102
100
  * @throws {@link InternalServerException} (server fault)
103
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
104
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
101
+ * <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>
105
102
  *
106
103
  * @throws {@link ResourceNotFoundException} (client fault)
107
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
108
- * provided the correct resource and try again.</p>
104
+ * <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>
109
105
  *
110
106
  * @throws {@link ServiceQuotaExceededException} (client fault)
111
107
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
112
108
  *
113
109
  * @throws {@link ThrottlingException} (client fault)
114
- * <p>The request was denied due to throttling. Reduce the number of requests and try
115
- * again.</p>
110
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
116
111
  *
117
112
  * @throws {@link ValidationException} (client fault)
118
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
119
- * correct input and try again.</p>
113
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
120
114
  *
121
115
  * @throws {@link QBusinessServiceException}
122
116
  * <p>Base exception class for all service exceptions from QBusiness service.</p>
@@ -92,31 +92,25 @@ declare const CreateRetrieverCommand_base: {
92
92
  * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
93
93
  *
94
94
  * @throws {@link AccessDeniedException} (client fault)
95
- * <p> You don't have access to perform this action. Make sure you have the required
96
- * permission policies and user accounts and try again.</p>
95
+ * <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>
97
96
  *
98
97
  * @throws {@link ConflictException} (client fault)
99
- * <p>You are trying to perform an action that conflicts with the current status of your
100
- * resource. Fix any inconsistencies with your resources and try again.</p>
98
+ * <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>
101
99
  *
102
100
  * @throws {@link InternalServerException} (server fault)
103
- * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
104
- * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
101
+ * <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>
105
102
  *
106
103
  * @throws {@link ResourceNotFoundException} (client fault)
107
- * <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
108
- * provided the correct resource and try again.</p>
104
+ * <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>
109
105
  *
110
106
  * @throws {@link ServiceQuotaExceededException} (client fault)
111
107
  * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
112
108
  *
113
109
  * @throws {@link ThrottlingException} (client fault)
114
- * <p>The request was denied due to throttling. Reduce the number of requests and try
115
- * again.</p>
110
+ * <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
116
111
  *
117
112
  * @throws {@link ValidationException} (client fault)
118
- * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
119
- * correct input and try again.</p>
113
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
120
114
  *
121
115
  * @throws {@link QBusinessServiceException}
122
116
  * <p>Base exception class for all service exceptions from QBusiness service.</p>