@aws-sdk/client-qbusiness 3.609.0 → 3.613.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 CHANGED
@@ -19,46 +19,6 @@ introduction to the service, see the <a href="https://docs.aws.amazon.com/amazon
19
19
  <p>For information about the IAM access control permissions you need to
20
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
21
  <i>Amazon Q Business User Guide</i>.</p>
22
- <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
23
- <ul>
24
- <li>
25
- <p>
26
- <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
27
- </p>
28
- </li>
29
- <li>
30
- <p>
31
- <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
32
- </p>
33
- </li>
34
- <li>
35
- <p>
36
- <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
37
- </p>
38
- </li>
39
- <li>
40
- <p>
41
- <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
42
- JavaScript</a>
43
- </p>
44
- </li>
45
- <li>
46
- <p>
47
- <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
48
- </p>
49
- </li>
50
- <li>
51
- <p>
52
- <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
53
- (Boto3)</a>
54
- </p>
55
- </li>
56
- <li>
57
- <p>
58
- <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
59
- </p>
60
- </li>
61
- </ul>
62
22
  <p>The following resources provide additional information about using the Amazon Q Business
63
23
  API:</p>
64
24
  <ul>
package/dist-cjs/index.js CHANGED
@@ -111,6 +111,7 @@ __export(src_exports, {
111
111
  MessageUsefulness: () => MessageUsefulness,
112
112
  MessageUsefulnessReason: () => MessageUsefulnessReason,
113
113
  NumberAttributeBoostingType: () => NumberAttributeBoostingType,
114
+ PersonalizationControlMode: () => PersonalizationControlMode,
114
115
  PluginAuthConfiguration: () => PluginAuthConfiguration,
115
116
  PluginBuildStatus: () => PluginBuildStatus,
116
117
  PluginState: () => PluginState,
@@ -440,6 +441,10 @@ var AttachmentsControlMode = {
440
441
  DISABLED: "DISABLED",
441
442
  ENABLED: "ENABLED"
442
443
  };
444
+ var PersonalizationControlMode = {
445
+ DISABLED: "DISABLED",
446
+ ENABLED: "ENABLED"
447
+ };
443
448
  var QAppsControlMode = {
444
449
  DISABLED: "DISABLED",
445
450
  ENABLED: "ENABLED"
@@ -1056,6 +1061,7 @@ var se_CreateApplicationCommand = /* @__PURE__ */ __name(async (input, context)
1056
1061
  displayName: [],
1057
1062
  encryptionConfiguration: (_) => (0, import_smithy_client._json)(_),
1058
1063
  identityCenterInstanceArn: [],
1064
+ personalizationConfiguration: (_) => (0, import_smithy_client._json)(_),
1059
1065
  qAppsConfiguration: (_) => (0, import_smithy_client._json)(_),
1060
1066
  roleArn: [],
1061
1067
  tags: (_) => (0, import_smithy_client._json)(_)
@@ -1673,6 +1679,7 @@ var se_UpdateApplicationCommand = /* @__PURE__ */ __name(async (input, context)
1673
1679
  description: [],
1674
1680
  displayName: [],
1675
1681
  identityCenterInstanceArn: [],
1682
+ personalizationConfiguration: (_) => (0, import_smithy_client._json)(_),
1676
1683
  qAppsConfiguration: (_) => (0, import_smithy_client._json)(_),
1677
1684
  roleArn: []
1678
1685
  })
@@ -2104,6 +2111,7 @@ var de_GetApplicationCommand = /* @__PURE__ */ __name(async (output, context) =>
2104
2111
  encryptionConfiguration: import_smithy_client._json,
2105
2112
  error: import_smithy_client._json,
2106
2113
  identityCenterApplicationArn: import_smithy_client.expectString,
2114
+ personalizationConfiguration: import_smithy_client._json,
2107
2115
  qAppsConfiguration: import_smithy_client._json,
2108
2116
  roleArn: import_smithy_client.expectString,
2109
2117
  status: import_smithy_client.expectString,
@@ -4532,6 +4540,7 @@ var paginateListWebExperiences = (0, import_core.createPaginator)(QBusinessClien
4532
4540
  ApplicationStatus,
4533
4541
  ConflictException,
4534
4542
  AttachmentsControlMode,
4543
+ PersonalizationControlMode,
4535
4544
  QAppsControlMode,
4536
4545
  InternalServerException,
4537
4546
  ResourceNotFoundException,
@@ -85,6 +85,10 @@ export const AttachmentsControlMode = {
85
85
  DISABLED: "DISABLED",
86
86
  ENABLED: "ENABLED",
87
87
  };
88
+ export const PersonalizationControlMode = {
89
+ DISABLED: "DISABLED",
90
+ ENABLED: "ENABLED",
91
+ };
88
92
  export const QAppsControlMode = {
89
93
  DISABLED: "DISABLED",
90
94
  ENABLED: "ENABLED",
@@ -100,6 +100,7 @@ export const se_CreateApplicationCommand = async (input, context) => {
100
100
  displayName: [],
101
101
  encryptionConfiguration: (_) => _json(_),
102
102
  identityCenterInstanceArn: [],
103
+ personalizationConfiguration: (_) => _json(_),
103
104
  qAppsConfiguration: (_) => _json(_),
104
105
  roleArn: [],
105
106
  tags: (_) => _json(_),
@@ -697,6 +698,7 @@ export const se_UpdateApplicationCommand = async (input, context) => {
697
698
  description: [],
698
699
  displayName: [],
699
700
  identityCenterInstanceArn: [],
701
+ personalizationConfiguration: (_) => _json(_),
700
702
  qAppsConfiguration: (_) => _json(_),
701
703
  roleArn: [],
702
704
  }));
@@ -1113,6 +1115,7 @@ export const de_GetApplicationCommand = async (output, context) => {
1113
1115
  encryptionConfiguration: _json,
1114
1116
  error: _json,
1115
1117
  identityCenterApplicationArn: __expectString,
1118
+ personalizationConfiguration: _json,
1116
1119
  qAppsConfiguration: _json,
1117
1120
  roleArn: __expectString,
1118
1121
  status: __expectString,
@@ -409,46 +409,6 @@ export interface QBusiness {
409
409
  * <p>For information about the IAM access control permissions you need to
410
410
  * 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
411
411
  * <i>Amazon Q Business User Guide</i>.</p>
412
- * <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
413
- * <ul>
414
- * <li>
415
- * <p>
416
- * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
417
- * </p>
418
- * </li>
419
- * <li>
420
- * <p>
421
- * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
422
- * </p>
423
- * </li>
424
- * <li>
425
- * <p>
426
- * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
427
- * </p>
428
- * </li>
429
- * <li>
430
- * <p>
431
- * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
432
- * JavaScript</a>
433
- * </p>
434
- * </li>
435
- * <li>
436
- * <p>
437
- * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
438
- * </p>
439
- * </li>
440
- * <li>
441
- * <p>
442
- * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
443
- * (Boto3)</a>
444
- * </p>
445
- * </li>
446
- * <li>
447
- * <p>
448
- * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
449
- * </p>
450
- * </li>
451
- * </ul>
452
412
  * <p>The following resources provide additional information about using the Amazon Q Business
453
413
  * API:</p>
454
414
  * <ul>
@@ -232,46 +232,6 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
232
232
  * <p>For information about the IAM access control permissions you need to
233
233
  * 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
234
234
  * <i>Amazon Q Business User Guide</i>.</p>
235
- * <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
236
- * <ul>
237
- * <li>
238
- * <p>
239
- * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
240
- * </p>
241
- * </li>
242
- * <li>
243
- * <p>
244
- * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
245
- * </p>
246
- * </li>
247
- * <li>
248
- * <p>
249
- * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
250
- * </p>
251
- * </li>
252
- * <li>
253
- * <p>
254
- * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
255
- * JavaScript</a>
256
- * </p>
257
- * </li>
258
- * <li>
259
- * <p>
260
- * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
261
- * </p>
262
- * </li>
263
- * <li>
264
- * <p>
265
- * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
266
- * (Boto3)</a>
267
- * </p>
268
- * </li>
269
- * <li>
270
- * <p>
271
- * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
272
- * </p>
273
- * </li>
274
- * </ul>
275
235
  * <p>The following resources provide additional information about using the Amazon Q Business
276
236
  * API:</p>
277
237
  * <ul>
@@ -31,9 +31,8 @@ declare const CreateApplicationCommand_base: {
31
31
  * <note>
32
32
  * <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
33
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
35
- * 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>.
36
- * You must use the Amazon Q Business console to assign subscription tiers to users.</p>
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>
37
36
  * </note>
38
37
  * @example
39
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -62,6 +61,9 @@ declare const CreateApplicationCommand_base: {
62
61
  * qAppsConfiguration: { // QAppsConfiguration
63
62
  * qAppsControlMode: "ENABLED" || "DISABLED", // required
64
63
  * },
64
+ * personalizationConfiguration: { // PersonalizationConfiguration
65
+ * personalizationControlMode: "ENABLED" || "DISABLED", // required
66
+ * },
65
67
  * };
66
68
  * const command = new CreateApplicationCommand(input);
67
69
  * const response = await client.send(command);
@@ -62,6 +62,9 @@ declare const GetApplicationCommand_base: {
62
62
  * // qAppsConfiguration: { // QAppsConfiguration
63
63
  * // qAppsControlMode: "ENABLED" || "DISABLED", // required
64
64
  * // },
65
+ * // personalizationConfiguration: { // PersonalizationConfiguration
66
+ * // personalizationControlMode: "ENABLED" || "DISABLED", // required
67
+ * // },
65
68
  * // };
66
69
  *
67
70
  * ```
@@ -46,6 +46,9 @@ declare const UpdateApplicationCommand_base: {
46
46
  * qAppsConfiguration: { // QAppsConfiguration
47
47
  * qAppsControlMode: "ENABLED" || "DISABLED", // required
48
48
  * },
49
+ * personalizationConfiguration: { // PersonalizationConfiguration
50
+ * personalizationControlMode: "ENABLED" || "DISABLED", // required
51
+ * },
49
52
  * };
50
53
  * const command = new UpdateApplicationCommand(input);
51
54
  * const response = await client.send(command);
@@ -12,46 +12,6 @@
12
12
  * <p>For information about the IAM access control permissions you need to
13
13
  * 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
14
14
  * <i>Amazon Q Business User Guide</i>.</p>
15
- * <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
16
- * <ul>
17
- * <li>
18
- * <p>
19
- * <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
20
- * </p>
21
- * </li>
22
- * <li>
23
- * <p>
24
- * <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
25
- * </p>
26
- * </li>
27
- * <li>
28
- * <p>
29
- * <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
30
- * </p>
31
- * </li>
32
- * <li>
33
- * <p>
34
- * <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
35
- * JavaScript</a>
36
- * </p>
37
- * </li>
38
- * <li>
39
- * <p>
40
- * <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
41
- * </p>
42
- * </li>
43
- * <li>
44
- * <p>
45
- * <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
46
- * (Boto3)</a>
47
- * </p>
48
- * </li>
49
- * <li>
50
- * <p>
51
- * <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
52
- * </p>
53
- * </li>
54
- * </ul>
55
15
  * <p>The following resources provide additional information about using the Amazon Q Business
56
16
  * API:</p>
57
17
  * <ul>
@@ -588,6 +588,32 @@ export interface EncryptionConfiguration {
588
588
  */
589
589
  kmsKeyId?: string;
590
590
  }
591
+ /**
592
+ * @public
593
+ * @enum
594
+ */
595
+ export declare const PersonalizationControlMode: {
596
+ readonly DISABLED: "DISABLED";
597
+ readonly ENABLED: "ENABLED";
598
+ };
599
+ /**
600
+ * @public
601
+ */
602
+ export type PersonalizationControlMode = (typeof PersonalizationControlMode)[keyof typeof PersonalizationControlMode];
603
+ /**
604
+ * <p>Configuration information about chat response personalization. For more information,
605
+ * see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
606
+ * @public
607
+ */
608
+ export interface PersonalizationConfiguration {
609
+ /**
610
+ * <p>An option to allow Amazon Q Business to customize chat responses using user
611
+ * specific metadata—specifically, location and job information—in your
612
+ * IAM Identity Center instance.</p>
613
+ * @public
614
+ */
615
+ personalizationControlMode: PersonalizationControlMode | undefined;
616
+ }
591
617
  /**
592
618
  * @public
593
619
  * @enum
@@ -683,10 +709,18 @@ export interface CreateApplicationRequest {
683
709
  */
684
710
  attachmentsConfiguration?: AttachmentsConfiguration;
685
711
  /**
686
- * <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
712
+ * <p>An option to allow end users to create and use Amazon Q Apps in the web
713
+ * experience.</p>
687
714
  * @public
688
715
  */
689
716
  qAppsConfiguration?: QAppsConfiguration;
717
+ /**
718
+ * <p>Configuration information about chat response personalization. For more information,
719
+ * see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>
720
+ * </p>
721
+ * @public
722
+ */
723
+ personalizationConfiguration?: PersonalizationConfiguration;
690
724
  }
691
725
  /**
692
726
  * @public
@@ -966,10 +1000,17 @@ export interface GetApplicationResponse {
966
1000
  */
967
1001
  attachmentsConfiguration?: AppliedAttachmentsConfiguration;
968
1002
  /**
969
- * <p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>
1003
+ * <p>Settings for whether end users can create and use Amazon Q Apps in the web
1004
+ * experience.</p>
970
1005
  * @public
971
1006
  */
972
1007
  qAppsConfiguration?: QAppsConfiguration;
1008
+ /**
1009
+ * <p>Configuration information about chat response personalization. For more information,
1010
+ * see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
1011
+ * @public
1012
+ */
1013
+ personalizationConfiguration?: PersonalizationConfiguration;
973
1014
  }
974
1015
  /**
975
1016
  * <p>Provides information about index capacity configuration.</p>
@@ -3236,10 +3277,17 @@ export interface UpdateApplicationRequest {
3236
3277
  */
3237
3278
  attachmentsConfiguration?: AttachmentsConfiguration;
3238
3279
  /**
3239
- * <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
3280
+ * <p>An option to allow end users to create and use Amazon Q Apps in the web
3281
+ * experience.</p>
3240
3282
  * @public
3241
3283
  */
3242
3284
  qAppsConfiguration?: QAppsConfiguration;
3285
+ /**
3286
+ * <p>Configuration information about chat response personalization. For more information,
3287
+ * see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
3288
+ * @public
3289
+ */
3290
+ personalizationConfiguration?: PersonalizationConfiguration;
3243
3291
  }
3244
3292
  /**
3245
3293
  * @public
@@ -199,6 +199,15 @@ export interface AttachmentsConfiguration {
199
199
  export interface EncryptionConfiguration {
200
200
  kmsKeyId?: string;
201
201
  }
202
+ export declare const PersonalizationControlMode: {
203
+ readonly DISABLED: "DISABLED";
204
+ readonly ENABLED: "ENABLED";
205
+ };
206
+ export type PersonalizationControlMode =
207
+ (typeof PersonalizationControlMode)[keyof typeof PersonalizationControlMode];
208
+ export interface PersonalizationConfiguration {
209
+ personalizationControlMode: PersonalizationControlMode | undefined;
210
+ }
202
211
  export declare const QAppsControlMode: {
203
212
  readonly DISABLED: "DISABLED";
204
213
  readonly ENABLED: "ENABLED";
@@ -222,6 +231,7 @@ export interface CreateApplicationRequest {
222
231
  clientToken?: string;
223
232
  attachmentsConfiguration?: AttachmentsConfiguration;
224
233
  qAppsConfiguration?: QAppsConfiguration;
234
+ personalizationConfiguration?: PersonalizationConfiguration;
225
235
  }
226
236
  export interface CreateApplicationResponse {
227
237
  applicationId?: string;
@@ -314,6 +324,7 @@ export interface GetApplicationResponse {
314
324
  error?: ErrorDetail;
315
325
  attachmentsConfiguration?: AppliedAttachmentsConfiguration;
316
326
  qAppsConfiguration?: QAppsConfiguration;
327
+ personalizationConfiguration?: PersonalizationConfiguration;
317
328
  }
318
329
  export interface IndexCapacityConfiguration {
319
330
  units?: number;
@@ -961,6 +972,7 @@ export interface UpdateApplicationRequest {
961
972
  roleArn?: string;
962
973
  attachmentsConfiguration?: AttachmentsConfiguration;
963
974
  qAppsConfiguration?: QAppsConfiguration;
975
+ personalizationConfiguration?: PersonalizationConfiguration;
964
976
  }
965
977
  export interface UpdateApplicationResponse {}
966
978
  export declare const WebExperienceSamplePromptsControlMode: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-qbusiness",
3
3
  "description": "AWS SDK for JavaScript Qbusiness Client for Node.js, Browser and React Native",
4
- "version": "3.609.0",
4
+ "version": "3.613.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-qbusiness",
@@ -20,12 +20,12 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.609.0",
24
- "@aws-sdk/client-sts": "3.609.0",
23
+ "@aws-sdk/client-sso-oidc": "3.613.0",
24
+ "@aws-sdk/client-sts": "3.613.0",
25
25
  "@aws-sdk/core": "3.609.0",
26
- "@aws-sdk/credential-provider-node": "3.609.0",
26
+ "@aws-sdk/credential-provider-node": "3.613.0",
27
27
  "@aws-sdk/eventstream-handler-node": "3.609.0",
28
- "@aws-sdk/middleware-eventstream": "3.609.0",
28
+ "@aws-sdk/middleware-eventstream": "3.613.0",
29
29
  "@aws-sdk/middleware-host-header": "3.609.0",
30
30
  "@aws-sdk/middleware-logger": "3.609.0",
31
31
  "@aws-sdk/middleware-recursion-detection": "3.609.0",