Skip to content

Commit 3022150

Browse files
author
awstools
committed
feat(client-qbusiness): Add personalization to Q Applications. Customers can enable or disable personalization when creating or updating a Q application with the personalization configuration.
1 parent af2d6d5 commit 3022150

File tree

10 files changed

+131
-171
lines changed

10 files changed

+131
-171
lines changed

‎clients/client-qbusiness/README.md

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -19,46 +19,6 @@ introduction to the service, see the <a href="https://docs.aws.amazon.com/amazon
1919
<p>For information about the IAM access control permissions you need to
2020
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
2121
<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>
6222
<p>The following resources provide additional information about using the Amazon Q Business
6323
API:</p>
6424
<ul>

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

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1052,46 +1052,6 @@ export interface QBusiness {
10521052
* <p>For information about the IAM access control permissions you need to
10531053
* 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
10541054
* <i>Amazon Q Business User Guide</i>.</p>
1055-
* <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
1056-
* <ul>
1057-
* <li>
1058-
* <p>
1059-
* <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
1060-
* </p>
1061-
* </li>
1062-
* <li>
1063-
* <p>
1064-
* <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
1065-
* </p>
1066-
* </li>
1067-
* <li>
1068-
* <p>
1069-
* <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
1070-
* </p>
1071-
* </li>
1072-
* <li>
1073-
* <p>
1074-
* <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
1075-
* JavaScript</a>
1076-
* </p>
1077-
* </li>
1078-
* <li>
1079-
* <p>
1080-
* <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
1081-
* </p>
1082-
* </li>
1083-
* <li>
1084-
* <p>
1085-
* <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
1086-
* (Boto3)</a>
1087-
* </p>
1088-
* </li>
1089-
* <li>
1090-
* <p>
1091-
* <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
1092-
* </p>
1093-
* </li>
1094-
* </ul>
10951055
* <p>The following resources provide additional information about using the Amazon Q Business
10961056
* API:</p>
10971057
* <ul>

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

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -487,46 +487,6 @@ export interface QBusinessClientResolvedConfig extends QBusinessClientResolvedCo
487487
* <p>For information about the IAM access control permissions you need to
488488
* 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
489489
* <i>Amazon Q Business User Guide</i>.</p>
490-
* <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
491-
* <ul>
492-
* <li>
493-
* <p>
494-
* <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
495-
* </p>
496-
* </li>
497-
* <li>
498-
* <p>
499-
* <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
500-
* </p>
501-
* </li>
502-
* <li>
503-
* <p>
504-
* <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
505-
* </p>
506-
* </li>
507-
* <li>
508-
* <p>
509-
* <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
510-
* JavaScript</a>
511-
* </p>
512-
* </li>
513-
* <li>
514-
* <p>
515-
* <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
516-
* </p>
517-
* </li>
518-
* <li>
519-
* <p>
520-
* <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
521-
* (Boto3)</a>
522-
* </p>
523-
* </li>
524-
* <li>
525-
* <p>
526-
* <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
527-
* </p>
528-
* </li>
529-
* </ul>
530490
* <p>The following resources provide additional information about using the Amazon Q Business
531491
* API:</p>
532492
* <ul>

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
3636
* <note>
3737
* <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
3838
* also available in Amazon Q Business Lite. For information on what's included in
39-
* Amazon Q Business Lite and what's included in
40-
* 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>.
41-
* You must use the Amazon Q Business console to assign subscription tiers to users.</p>
39+
* 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
40+
* subscription tiers to users.</p>
4241
* </note>
4342
* @example
4443
* Use a bare-bones client and the command you need to make an API call.
@@ -67,6 +66,9 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
6766
* qAppsConfiguration: { // QAppsConfiguration
6867
* qAppsControlMode: "ENABLED" || "DISABLED", // required
6968
* },
69+
* personalizationConfiguration: { // PersonalizationConfiguration
70+
* personalizationControlMode: "ENABLED" || "DISABLED", // required
71+
* },
7072
* };
7173
* const command = new CreateApplicationCommand(input);
7274
* const response = await client.send(command);

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M
6767
* // qAppsConfiguration: { // QAppsConfiguration
6868
* // qAppsControlMode: "ENABLED" || "DISABLED", // required
6969
* // },
70+
* // personalizationConfiguration: { // PersonalizationConfiguration
71+
* // personalizationControlMode: "ENABLED" || "DISABLED", // required
72+
* // },
7073
* // };
7174
*
7275
* ```

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons
4747
* qAppsConfiguration: { // QAppsConfiguration
4848
* qAppsControlMode: "ENABLED" || "DISABLED", // required
4949
* },
50+
* personalizationConfiguration: { // PersonalizationConfiguration
51+
* personalizationControlMode: "ENABLED" || "DISABLED", // required
52+
* },
5053
* };
5154
* const command = new UpdateApplicationCommand(input);
5255
* const response = await client.send(command);

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

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -14,46 +14,6 @@
1414
* <p>For information about the IAM access control permissions you need to
1515
* 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
1616
* <i>Amazon Q Business User Guide</i>.</p>
17-
* <p>You can use the following AWS SDKs to access Amazon Q Business APIs:</p>
18-
* <ul>
19-
* <li>
20-
* <p>
21-
* <a href="https://docs.aws.amazon.com/sdk-for-cpp">AWS SDK for C++</a>
22-
* </p>
23-
* </li>
24-
* <li>
25-
* <p>
26-
* <a href="https://docs.aws.amazon.com/sdk-for-go">AWS SDK for Go</a>
27-
* </p>
28-
* </li>
29-
* <li>
30-
* <p>
31-
* <a href="https://docs.aws.amazon.com/sdk-for-java">AWS SDK for Java</a>
32-
* </p>
33-
* </li>
34-
* <li>
35-
* <p>
36-
* <a href="https://docs.aws.amazon.com/sdk-for-javascript">AWS SDK for
37-
* JavaScript</a>
38-
* </p>
39-
* </li>
40-
* <li>
41-
* <p>
42-
* <a href="https://docs.aws.amazon.com/sdk-for-net">AWS SDK for .NET</a>
43-
* </p>
44-
* </li>
45-
* <li>
46-
* <p>
47-
* <a href="https://docs.aws.amazon.com/pythonsdk">AWS SDK for Python
48-
* (Boto3)</a>
49-
* </p>
50-
* </li>
51-
* <li>
52-
* <p>
53-
* <a href="https://docs.aws.amazon.com/sdk-for-ruby">AWS SDK for Ruby</a>
54-
* </p>
55-
* </li>
56-
* </ul>
5717
* <p>The following resources provide additional information about using the Amazon Q Business
5818
* API:</p>
5919
* <ul>

‎clients/client-qbusiness/src/models/models_0.ts

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,35 @@ export interface EncryptionConfiguration {
695695
kmsKeyId?: string;
696696
}
697697

698+
/**
699+
* @public
700+
* @enum
701+
*/
702+
export const PersonalizationControlMode = {
703+
DISABLED: "DISABLED",
704+
ENABLED: "ENABLED",
705+
} as const;
706+
707+
/**
708+
* @public
709+
*/
710+
export type PersonalizationControlMode = (typeof PersonalizationControlMode)[keyof typeof PersonalizationControlMode];
711+
712+
/**
713+
* <p>Configuration information about chat response personalization. For more information,
714+
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
715+
* @public
716+
*/
717+
export interface PersonalizationConfiguration {
718+
/**
719+
* <p>An option to allow Amazon Q Business to customize chat responses using user
720+
* specific metadata—specifically, location and job information—in your
721+
* IAM Identity Center instance.</p>
722+
* @public
723+
*/
724+
personalizationControlMode: PersonalizationControlMode | undefined;
725+
}
726+
698727
/**
699728
* @public
700729
* @enum
@@ -803,10 +832,19 @@ export interface CreateApplicationRequest {
803832
attachmentsConfiguration?: AttachmentsConfiguration;
804833

805834
/**
806-
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
835+
* <p>An option to allow end users to create and use Amazon Q Apps in the web
836+
* experience.</p>
807837
* @public
808838
*/
809839
qAppsConfiguration?: QAppsConfiguration;
840+
841+
/**
842+
* <p>Configuration information about chat response personalization. For more information,
843+
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>
844+
* </p>
845+
* @public
846+
*/
847+
personalizationConfiguration?: PersonalizationConfiguration;
810848
}
811849

812850
/**
@@ -1164,10 +1202,18 @@ export interface GetApplicationResponse {
11641202
attachmentsConfiguration?: AppliedAttachmentsConfiguration;
11651203

11661204
/**
1167-
* <p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>
1205+
* <p>Settings for whether end users can create and use Amazon Q Apps in the web
1206+
* experience.</p>
11681207
* @public
11691208
*/
11701209
qAppsConfiguration?: QAppsConfiguration;
1210+
1211+
/**
1212+
* <p>Configuration information about chat response personalization. For more information,
1213+
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
1214+
* @public
1215+
*/
1216+
personalizationConfiguration?: PersonalizationConfiguration;
11711217
}
11721218

11731219
/**
@@ -3776,10 +3822,18 @@ export interface UpdateApplicationRequest {
37763822
attachmentsConfiguration?: AttachmentsConfiguration;
37773823

37783824
/**
3779-
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
3825+
* <p>An option to allow end users to create and use Amazon Q Apps in the web
3826+
* experience.</p>
37803827
* @public
37813828
*/
37823829
qAppsConfiguration?: QAppsConfiguration;
3830+
3831+
/**
3832+
* <p>Configuration information about chat response personalization. For more information,
3833+
* see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
3834+
* @public
3835+
*/
3836+
personalizationConfiguration?: PersonalizationConfiguration;
37833837
}
37843838

37853839
/**

‎clients/client-qbusiness/src/protocols/Aws_restJson1.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ import {
195195
NoAuthConfiguration,
196196
NumberAttributeBoostingConfiguration,
197197
OAuth2ClientCredentialConfiguration,
198+
PersonalizationConfiguration,
198199
Plugin,
199200
PluginAuthConfiguration,
200201
PluginConfiguration,
@@ -363,6 +364,7 @@ export const se_CreateApplicationCommand = async (
363364
displayName: [],
364365
encryptionConfiguration: (_) => _json(_),
365366
identityCenterInstanceArn: [],
367+
personalizationConfiguration: (_) => _json(_),
366368
qAppsConfiguration: (_) => _json(_),
367369
roleArn: [],
368370
tags: (_) => _json(_),
@@ -1288,6 +1290,7 @@ export const se_UpdateApplicationCommand = async (
12881290
description: [],
12891291
displayName: [],
12901292
identityCenterInstanceArn: [],
1293+
personalizationConfiguration: (_) => _json(_),
12911294
qAppsConfiguration: (_) => _json(_),
12921295
roleArn: [],
12931296
})
@@ -1922,6 +1925,7 @@ export const de_GetApplicationCommand = async (
19221925
encryptionConfiguration: _json,
19231926
error: _json,
19241927
identityCenterApplicationArn: __expectString,
1928+
personalizationConfiguration: _json,
19251929
qAppsConfiguration: _json,
19261930
roleArn: __expectString,
19271931
status: __expectString,
@@ -3402,6 +3406,8 @@ const se_MessageUsefulnessFeedback = (input: MessageUsefulnessFeedback, context:
34023406

34033407
// se_OAuth2ClientCredentialConfiguration omitted.
34043408

3409+
// se_PersonalizationConfiguration omitted.
3410+
34053411
// se_PluginAuthConfiguration omitted.
34063412

34073413
// se_PluginConfiguration omitted.
@@ -3985,6 +3991,8 @@ const de_MetadataEvent = (output: any, context: __SerdeContext): MetadataEvent =
39853991

39863992
// de_OAuth2ClientCredentialConfiguration omitted.
39873993

3994+
// de_PersonalizationConfiguration omitted.
3995+
39883996
/**
39893997
* deserializeAws_restJson1Plugin
39903998
*/

0 commit comments

Comments
 (0)