@aws-sdk/client-qbusiness 3.556.0 → 3.557.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 (65) hide show
  1. package/README.md +15 -16
  2. package/dist-cjs/index.js +36 -5
  3. package/dist-es/models/models_0.js +17 -0
  4. package/dist-es/protocols/Aws_restJson1.js +13 -5
  5. package/dist-types/QBusiness.d.ts +15 -16
  6. package/dist-types/QBusinessClient.d.ts +15 -16
  7. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +3 -3
  8. package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -7
  9. package/dist-types/commands/ChatSyncCommand.d.ts +10 -4
  10. package/dist-types/commands/CreateApplicationCommand.d.ts +5 -4
  11. package/dist-types/commands/CreateDataSourceCommand.d.ts +4 -4
  12. package/dist-types/commands/CreateIndexCommand.d.ts +4 -4
  13. package/dist-types/commands/CreatePluginCommand.d.ts +4 -4
  14. package/dist-types/commands/CreateRetrieverCommand.d.ts +4 -4
  15. package/dist-types/commands/CreateUserCommand.d.ts +3 -3
  16. package/dist-types/commands/CreateWebExperienceCommand.d.ts +5 -4
  17. package/dist-types/commands/DeleteApplicationCommand.d.ts +3 -3
  18. package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +3 -3
  19. package/dist-types/commands/DeleteConversationCommand.d.ts +4 -4
  20. package/dist-types/commands/DeleteDataSourceCommand.d.ts +3 -3
  21. package/dist-types/commands/DeleteGroupCommand.d.ts +2 -2
  22. package/dist-types/commands/DeleteIndexCommand.d.ts +3 -3
  23. package/dist-types/commands/DeletePluginCommand.d.ts +3 -3
  24. package/dist-types/commands/DeleteRetrieverCommand.d.ts +3 -3
  25. package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
  26. package/dist-types/commands/DeleteWebExperienceCommand.d.ts +3 -3
  27. package/dist-types/commands/GetApplicationCommand.d.ts +4 -3
  28. package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +6 -3
  29. package/dist-types/commands/GetDataSourceCommand.d.ts +3 -3
  30. package/dist-types/commands/GetGroupCommand.d.ts +2 -2
  31. package/dist-types/commands/GetIndexCommand.d.ts +3 -3
  32. package/dist-types/commands/GetPluginCommand.d.ts +3 -3
  33. package/dist-types/commands/GetRetrieverCommand.d.ts +3 -3
  34. package/dist-types/commands/GetUserCommand.d.ts +2 -2
  35. package/dist-types/commands/GetWebExperienceCommand.d.ts +4 -3
  36. package/dist-types/commands/ListApplicationsCommand.d.ts +3 -3
  37. package/dist-types/commands/ListConversationsCommand.d.ts +4 -4
  38. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +3 -3
  39. package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -3
  40. package/dist-types/commands/ListDocumentsCommand.d.ts +2 -2
  41. package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
  42. package/dist-types/commands/ListIndicesCommand.d.ts +3 -3
  43. package/dist-types/commands/ListMessagesCommand.d.ts +4 -4
  44. package/dist-types/commands/ListPluginsCommand.d.ts +3 -3
  45. package/dist-types/commands/ListRetrieversCommand.d.ts +3 -3
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
  47. package/dist-types/commands/ListWebExperiencesCommand.d.ts +3 -3
  48. package/dist-types/commands/PutFeedbackCommand.d.ts +4 -4
  49. package/dist-types/commands/PutGroupCommand.d.ts +4 -4
  50. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +4 -4
  51. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
  52. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  53. package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
  54. package/dist-types/commands/UpdateApplicationCommand.d.ts +3 -3
  55. package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +7 -4
  56. package/dist-types/commands/UpdateDataSourceCommand.d.ts +3 -3
  57. package/dist-types/commands/UpdateIndexCommand.d.ts +4 -4
  58. package/dist-types/commands/UpdatePluginCommand.d.ts +4 -4
  59. package/dist-types/commands/UpdateRetrieverCommand.d.ts +4 -4
  60. package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
  61. package/dist-types/commands/UpdateWebExperienceCommand.d.ts +3 -3
  62. package/dist-types/index.d.ts +15 -16
  63. package/dist-types/models/models_0.d.ts +491 -320
  64. package/dist-types/ts3.4/models/models_0.d.ts +52 -5
  65. package/package.json +1 -1
@@ -26,7 +26,7 @@ declare const UpdateApplicationCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an existing Amazon Q application.</p>
29
+ * <p>Updates an existing Amazon Q Business application.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -63,7 +63,7 @@ declare const UpdateApplicationCommand_base: {
63
63
  * resource. Fix any inconsistences with your resources and try again.</p>
64
64
  *
65
65
  * @throws {@link InternalServerException} (server fault)
66
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
66
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
67
67
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
68
68
  *
69
69
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -75,7 +75,7 @@ declare const UpdateApplicationCommand_base: {
75
75
  * again.</p>
76
76
  *
77
77
  * @throws {@link ValidationException} (client fault)
78
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
78
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
79
79
  * correct input and try again.</p>
80
80
  *
81
81
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdateChatControlsConfigurationCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an set of chat controls configured for an existing Amazon Q
29
+ * <p>Updates an set of chat controls configured for an existing Amazon Q Business
30
30
  * application.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -133,6 +133,9 @@ declare const UpdateChatControlsConfigurationCommand_base: {
133
133
  * ],
134
134
  * },
135
135
  * ],
136
+ * creatorModeConfiguration: { // CreatorModeConfiguration
137
+ * creatorModeControl: "ENABLED" || "DISABLED", // required
138
+ * },
136
139
  * };
137
140
  * const command = new UpdateChatControlsConfigurationCommand(input);
138
141
  * const response = await client.send(command);
@@ -155,7 +158,7 @@ declare const UpdateChatControlsConfigurationCommand_base: {
155
158
  * resource. Fix any inconsistences with your resources and try again.</p>
156
159
  *
157
160
  * @throws {@link InternalServerException} (server fault)
158
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
161
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
159
162
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
160
163
  *
161
164
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -163,14 +166,14 @@ declare const UpdateChatControlsConfigurationCommand_base: {
163
166
  * resource and try again.</p>
164
167
  *
165
168
  * @throws {@link ServiceQuotaExceededException} (client fault)
166
- * <p>You have exceeded the set limits for your Amazon Q service. </p>
169
+ * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
167
170
  *
168
171
  * @throws {@link ThrottlingException} (client fault)
169
172
  * <p>The request was denied due to throttling. Reduce the number of requests and try
170
173
  * again.</p>
171
174
  *
172
175
  * @throws {@link ValidationException} (client fault)
173
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
176
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
174
177
  * correct input and try again.</p>
175
178
  *
176
179
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdateDataSourceCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an existing Amazon Q data source connector.</p>
29
+ * <p>Updates an existing Amazon Q Business data source connector.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -137,7 +137,7 @@ declare const UpdateDataSourceCommand_base: {
137
137
  * resource. Fix any inconsistences with your resources and try again.</p>
138
138
  *
139
139
  * @throws {@link InternalServerException} (server fault)
140
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
140
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
141
141
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
142
142
  *
143
143
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -149,7 +149,7 @@ declare const UpdateDataSourceCommand_base: {
149
149
  * again.</p>
150
150
  *
151
151
  * @throws {@link ValidationException} (client fault)
152
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
152
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
153
153
  * correct input and try again.</p>
154
154
  *
155
155
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdateIndexCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an Amazon Q index.</p>
29
+ * <p>Updates an Amazon Q Business index.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -70,7 +70,7 @@ declare const UpdateIndexCommand_base: {
70
70
  * resource. Fix any inconsistences with your resources and try again.</p>
71
71
  *
72
72
  * @throws {@link InternalServerException} (server fault)
73
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
73
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
74
74
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
75
75
  *
76
76
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -78,14 +78,14 @@ declare const UpdateIndexCommand_base: {
78
78
  * resource and try again.</p>
79
79
  *
80
80
  * @throws {@link ServiceQuotaExceededException} (client fault)
81
- * <p>You have exceeded the set limits for your Amazon Q service. </p>
81
+ * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
82
82
  *
83
83
  * @throws {@link ThrottlingException} (client fault)
84
84
  * <p>The request was denied due to throttling. Reduce the number of requests and try
85
85
  * again.</p>
86
86
  *
87
87
  * @throws {@link ValidationException} (client fault)
88
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
88
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
89
89
  * correct input and try again.</p>
90
90
  *
91
91
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdatePluginCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an Amazon Q plugin.</p>
29
+ * <p>Updates an Amazon Q Business plugin.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -71,7 +71,7 @@ declare const UpdatePluginCommand_base: {
71
71
  * resource. Fix any inconsistences with your resources and try again.</p>
72
72
  *
73
73
  * @throws {@link InternalServerException} (server fault)
74
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
74
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
75
75
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
76
76
  *
77
77
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -79,14 +79,14 @@ declare const UpdatePluginCommand_base: {
79
79
  * resource and try again.</p>
80
80
  *
81
81
  * @throws {@link ServiceQuotaExceededException} (client fault)
82
- * <p>You have exceeded the set limits for your Amazon Q service. </p>
82
+ * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
83
83
  *
84
84
  * @throws {@link ThrottlingException} (client fault)
85
85
  * <p>The request was denied due to throttling. Reduce the number of requests and try
86
86
  * again.</p>
87
87
  *
88
88
  * @throws {@link ValidationException} (client fault)
89
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
89
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
90
90
  * correct input and try again.</p>
91
91
  *
92
92
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdateRetrieverCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates the retriever used for your Amazon Q application.</p>
29
+ * <p>Updates the retriever used for your Amazon Q Business application.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -89,7 +89,7 @@ declare const UpdateRetrieverCommand_base: {
89
89
  * resource. Fix any inconsistences with your resources and try again.</p>
90
90
  *
91
91
  * @throws {@link InternalServerException} (server fault)
92
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
92
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
93
93
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
94
94
  *
95
95
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -97,14 +97,14 @@ declare const UpdateRetrieverCommand_base: {
97
97
  * resource and try again.</p>
98
98
  *
99
99
  * @throws {@link ServiceQuotaExceededException} (client fault)
100
- * <p>You have exceeded the set limits for your Amazon Q service. </p>
100
+ * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
101
101
  *
102
102
  * @throws {@link ThrottlingException} (client fault)
103
103
  * <p>The request was denied due to throttling. Reduce the number of requests and try
104
104
  * again.</p>
105
105
  *
106
106
  * @throws {@link ValidationException} (client fault)
107
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
107
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
108
108
  * correct input and try again.</p>
109
109
  *
110
110
  * @throws {@link QBusinessServiceException}
@@ -90,7 +90,7 @@ declare const UpdateUserCommand_base: {
90
90
  * permission policies and user accounts and try again.</p>
91
91
  *
92
92
  * @throws {@link InternalServerException} (server fault)
93
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
93
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
94
94
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
95
95
  *
96
96
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -98,14 +98,14 @@ declare const UpdateUserCommand_base: {
98
98
  * resource and try again.</p>
99
99
  *
100
100
  * @throws {@link ServiceQuotaExceededException} (client fault)
101
- * <p>You have exceeded the set limits for your Amazon Q service. </p>
101
+ * <p>You have exceeded the set limits for your Amazon Q Business service. </p>
102
102
  *
103
103
  * @throws {@link ThrottlingException} (client fault)
104
104
  * <p>The request was denied due to throttling. Reduce the number of requests and try
105
105
  * again.</p>
106
106
  *
107
107
  * @throws {@link ValidationException} (client fault)
108
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
108
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
109
109
  * correct input and try again.</p>
110
110
  *
111
111
  * @throws {@link QBusinessServiceException}
@@ -26,7 +26,7 @@ declare const UpdateWebExperienceCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Updates an Amazon Q web experience. </p>
29
+ * <p>Updates an Amazon Q Business web experience. </p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -70,7 +70,7 @@ declare const UpdateWebExperienceCommand_base: {
70
70
  * resource. Fix any inconsistences with your resources and try again.</p>
71
71
  *
72
72
  * @throws {@link InternalServerException} (server fault)
73
- * <p>An issue occurred with the internal server used for your Amazon Q service. Wait
73
+ * <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
74
74
  * some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
75
75
  *
76
76
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -82,7 +82,7 @@ declare const UpdateWebExperienceCommand_base: {
82
82
  * again.</p>
83
83
  *
84
84
  * @throws {@link ValidationException} (client fault)
85
- * <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
85
+ * <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
86
86
  * correct input and try again.</p>
87
87
  *
88
88
  * @throws {@link QBusinessServiceException}
@@ -2,21 +2,20 @@
2
2
  * <note>
3
3
  * <p>Amazon Q is in preview release and is subject to change.</p>
4
4
  * </note>
5
- * <p>This is the <i>Amazon Q (for business use)</i> API Reference.
6
- * Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that
7
- * you can deploy within your organization. Amazon Q enhances employee productivity by
8
- * supporting key tasks such as question-answering, knowledge discovery, writing email
9
- * messages, summarizing text, drafting document outlines, and brainstorming ideas. Users
10
- * ask questions of Amazon Q and get answers that are presented in a conversational
11
- * manner. For an introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
12
- * <i>Amazon Q (for business use) Developer
13
- * Guide</i>
5
+ * <p>This is the <i>Amazon Q Business</i> API Reference. Amazon Q Business is a fully
6
+ * managed, generative-AI powered enterprise chat assistant that you can deploy within your
7
+ * organization. Amazon Q Business enhances employee productivity by supporting key tasks such
8
+ * as question-answering, knowledge discovery, writing email messages, summarizing text,
9
+ * drafting document outlines, and brainstorming ideas. Users ask questions of
10
+ * Amazon Q Business and get answers that are presented in a conversational manner. For an
11
+ * introduction to the service, see the <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html">
12
+ * <i>Amazon Q Business User Guide</i>
14
13
  * </a>.</p>
15
- * <p>For an overview of the Amazon Q APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview">Overview of Amazon Q API operations</a>.</p>
14
+ * <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>
16
15
  * <p>For information about the IAM access control permissions you need to
17
- * use this API, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html">IAM roles for Amazon Q</a> in the
18
- * <i>Amazon Q (for business use) Developer Guide</i>.</p>
19
- * <p>You can use the following AWS SDKs to access Amazon Q APIs:</p>
16
+ * 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
17
+ * <i>Amazon Q Business User Guide</i>.</p>
18
+ * <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
20
19
  * <ul>
21
20
  * <li>
22
21
  * <p>
@@ -56,21 +55,21 @@
56
55
  * </p>
57
56
  * </li>
58
57
  * </ul>
59
- * <p>The following resources provide additional information about using the Amazon Q
58
+ * <p>The following resources provide additional information about using the Amazon Q Business
60
59
  * API:</p>
61
60
  * <ul>
62
61
  * <li>
63
62
  * <p>
64
63
  * <i>
65
64
  * <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html">Setting up for
66
- * Amazon Q</a>
65
+ * Amazon Q Business</a>
67
66
  * </i>
68
67
  * </p>
69
68
  * </li>
70
69
  * <li>
71
70
  * <p>
72
71
  * <i>
73
- * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q CLI Reference</a>
72
+ * <a href="https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html">Amazon Q Business CLI Reference</a>
74
73
  * </i>
75
74
  * </p>
76
75
  * </li>