Skip to content

Commit 55c8f49

Browse files
author
awstools
committed
feat(client-qbusiness): Allow enable/disable Q Apps when creating/updating a Q application; Return the Q Apps enablement information when getting a Q application.
1 parent 08e7ceb commit 55c8f49

File tree

6 files changed

+120
-10
lines changed

6 files changed

+120
-10
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
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
3939
* 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/what-is.html#tiers">Amazon Q Business tiers</a>.
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>.
4141
* You must use the Amazon Q Business console to assign subscription tiers to users.</p>
4242
* </note>
4343
* @example
@@ -64,6 +64,9 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
6464
* attachmentsConfiguration: { // AttachmentsConfiguration
6565
* attachmentsControlMode: "ENABLED" || "DISABLED", // required
6666
* },
67+
* qAppsConfiguration: { // QAppsConfiguration
68+
* qAppsControlMode: "ENABLED" || "DISABLED", // required
69+
* },
6770
* };
6871
* const command = new CreateApplicationCommand(input);
6972
* 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
@@ -64,6 +64,9 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M
6464
* // attachmentsConfiguration: { // AppliedAttachmentsConfiguration
6565
* // attachmentsControlMode: "ENABLED" || "DISABLED",
6666
* // },
67+
* // qAppsConfiguration: { // QAppsConfiguration
68+
* // qAppsControlMode: "ENABLED" || "DISABLED", // required
69+
* // },
6770
* // };
6871
*
6972
* ```

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons
4444
* attachmentsConfiguration: { // AttachmentsConfiguration
4545
* attachmentsControlMode: "ENABLED" || "DISABLED", // required
4646
* },
47+
* qAppsConfiguration: { // QAppsConfiguration
48+
* qAppsControlMode: "ENABLED" || "DISABLED", // required
49+
* },
4750
* };
4851
* const command = new UpdateApplicationCommand(input);
4952
* const response = await client.send(command);

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

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

698+
/**
699+
* @public
700+
* @enum
701+
*/
702+
export const QAppsControlMode = {
703+
DISABLED: "DISABLED",
704+
ENABLED: "ENABLED",
705+
} as const;
706+
707+
/**
708+
* @public
709+
*/
710+
export type QAppsControlMode = (typeof QAppsControlMode)[keyof typeof QAppsControlMode];
711+
712+
/**
713+
* <p>Configuration information about Amazon Q Apps. (preview feature)</p>
714+
* @public
715+
*/
716+
export interface QAppsConfiguration {
717+
/**
718+
* <p>Status information about whether end users can create and use Amazon Q Apps in the web experience.</p>
719+
* @public
720+
*/
721+
qAppsControlMode: QAppsControlMode | undefined;
722+
}
723+
698724
/**
699725
* <p>A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and
700726
* values can consist of Unicode letters, digits, white space, and any of the following
@@ -775,6 +801,12 @@ export interface CreateApplicationRequest {
775801
* @public
776802
*/
777803
attachmentsConfiguration?: AttachmentsConfiguration;
804+
805+
/**
806+
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
807+
* @public
808+
*/
809+
qAppsConfiguration?: QAppsConfiguration;
778810
}
779811

780812
/**
@@ -1130,6 +1162,12 @@ export interface GetApplicationResponse {
11301162
* @public
11311163
*/
11321164
attachmentsConfiguration?: AppliedAttachmentsConfiguration;
1165+
1166+
/**
1167+
* <p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>
1168+
* @public
1169+
*/
1170+
qAppsConfiguration?: QAppsConfiguration;
11331171
}
11341172

11351173
/**
@@ -1176,7 +1214,7 @@ export interface CreateIndexRequest {
11761214

11771215
/**
11781216
* <p>The index type that's suitable for your needs. For more information on what's included
1179-
* in each type of index or index tier, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers">Amazon Q Business
1217+
* in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business
11801218
* tiers</a>.</p>
11811219
* @public
11821220
*/
@@ -3736,6 +3774,12 @@ export interface UpdateApplicationRequest {
37363774
* @public
37373775
*/
37383776
attachmentsConfiguration?: AttachmentsConfiguration;
3777+
3778+
/**
3779+
* <p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>
3780+
* @public
3781+
*/
3782+
qAppsConfiguration?: QAppsConfiguration;
37393783
}
37403784

37413785
/**
@@ -6843,9 +6887,8 @@ export interface AttributeFilter {
68436887

68446888
/**
68456889
* <p>Returns <code>true</code> when a document contains any of the specified document
6846-
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
6847-
* <code>longValue</code>, <code>stringListValue</code> and
6848-
* <code>stringValue</code>.</p>
6890+
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
6891+
* <code>stringListValue</code>.</p>
68496892
* @public
68506893
*/
68516894
containsAny?: DocumentAttribute;
@@ -6939,7 +6982,7 @@ export interface ChatSyncInput {
69396982
conversationId?: string;
69406983

69416984
/**
6942-
* <p>The identifier of the previous end user text input message in a conversation.</p>
6985+
* <p>The identifier of the previous system message in a conversation.</p>
69436986
* @public
69446987
*/
69456988
parentMessageId?: string;

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ import {
201201
Principal,
202202
PrincipalGroup,
203203
PrincipalUser,
204+
QAppsConfiguration,
204205
ResourceNotFoundException,
205206
RetrieverConfiguration,
206207
Rule,
@@ -360,6 +361,7 @@ export const se_CreateApplicationCommand = async (
360361
displayName: [],
361362
encryptionConfiguration: (_) => _json(_),
362363
identityCenterInstanceArn: [],
364+
qAppsConfiguration: (_) => _json(_),
363365
roleArn: [],
364366
tags: (_) => _json(_),
365367
})
@@ -1284,6 +1286,7 @@ export const se_UpdateApplicationCommand = async (
12841286
description: [],
12851287
displayName: [],
12861288
identityCenterInstanceArn: [],
1289+
qAppsConfiguration: (_) => _json(_),
12871290
roleArn: [],
12881291
})
12891292
);
@@ -1917,6 +1920,7 @@ export const de_GetApplicationCommand = async (
19171920
encryptionConfiguration: _json,
19181921
error: _json,
19191922
identityCenterApplicationArn: __expectString,
1923+
qAppsConfiguration: _json,
19201924
roleArn: __expectString,
19211925
status: __expectString,
19221926
updatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
@@ -3408,6 +3412,8 @@ const se_MessageUsefulnessFeedback = (input: MessageUsefulnessFeedback, context:
34083412

34093413
// se_PrincipalUser omitted.
34103414

3415+
// se_QAppsConfiguration omitted.
3416+
34113417
// se_RetrieverConfiguration omitted.
34123418

34133419
// se_Rule omitted.
@@ -4007,6 +4013,8 @@ const de_Plugins = (output: any, context: __SerdeContext): Plugin[] => {
40074013
return retVal;
40084014
};
40094015

4016+
// de_QAppsConfiguration omitted.
4017+
40104018
// de_Retriever omitted.
40114019

40124020
// de_RetrieverConfiguration omitted.

‎codegen/sdk-codegen/aws-models/qbusiness.json

Lines changed: 54 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@
760760
"containsAny": {
761761
"target": "com.amazonaws.qbusiness#DocumentAttribute",
762762
"traits": {
763-
"smithy.api#documentation": "<p>Returns <code>true</code> when a document contains any of the specified document\n attributes or metadata fields. Supported for the following <a href=\"https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html\">document attribute value types</a>: <code>dateValue</code>,\n <code>longValue</code>, <code>stringListValue</code> and\n <code>stringValue</code>.</p>"
763+
"smithy.api#documentation": "<p>Returns <code>true</code> when a document contains any of the specified document\n attributes or metadata fields. Supported for the following <a href=\"https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html\">document attribute value types</a>:\n <code>stringListValue</code>.</p>"
764764
}
765765
},
766766
"greaterThan": {
@@ -1539,7 +1539,7 @@
15391539
"parentMessageId": {
15401540
"target": "com.amazonaws.qbusiness#MessageId",
15411541
"traits": {
1542-
"smithy.api#documentation": "<p>The identifier of the previous end user text input message in a conversation.</p>"
1542+
"smithy.api#documentation": "<p>The identifier of the previous system message in a conversation.</p>"
15431543
}
15441544
},
15451545
"attributeFilter": {
@@ -1878,7 +1878,7 @@
18781878
"kms:DescribeKey",
18791879
"kms:CreateGrant"
18801880
],
1881-
"smithy.api#documentation": "<p>Creates an Amazon Q Business application.</p>\n <note>\n <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are \n also available in Amazon Q Business Lite. For information on what's included in \n Amazon Q Business Lite and what's included in \n Amazon Q Business Pro, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers\">Amazon Q Business tiers</a>. \n You must use the Amazon Q Business console to assign subscription tiers to users.</p>\n </note>",
1881+
"smithy.api#documentation": "<p>Creates an Amazon Q Business application.</p>\n <note>\n <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are \n also available in Amazon Q Business Lite. For information on what's included in \n Amazon Q Business Lite and what's included in \n 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>. \n You must use the Amazon Q Business console to assign subscription tiers to users.</p>\n </note>",
18821882
"smithy.api#http": {
18831883
"uri": "/applications",
18841884
"method": "POST"
@@ -1940,6 +1940,12 @@
19401940
"aws.cloudformation#cfnMutability": "full",
19411941
"smithy.api#documentation": "<p>An option to allow end users to upload files directly during chat.</p>"
19421942
}
1943+
},
1944+
"qAppsConfiguration": {
1945+
"target": "com.amazonaws.qbusiness#QAppsConfiguration",
1946+
"traits": {
1947+
"smithy.api#documentation": "<p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>"
1948+
}
19431949
}
19441950
},
19451951
"traits": {
@@ -2174,7 +2180,7 @@
21742180
"type": {
21752181
"target": "com.amazonaws.qbusiness#IndexType",
21762182
"traits": {
2177-
"smithy.api#documentation": "<p>The index type that's suitable for your needs. For more information on what's included\n in each type of index or index tier, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/what-is.html#tiers\">Amazon Q Business\n tiers</a>.</p>"
2183+
"smithy.api#documentation": "<p>The index type that's suitable for your needs. For more information on what's included\n in each type of index, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers\">Amazon Q Business\n tiers</a>.</p>"
21782184
}
21792185
},
21802186
"description": {
@@ -5219,6 +5225,12 @@
52195225
"aws.cloudformation#cfnExcludeProperty": {},
52205226
"smithy.api#documentation": "<p>Settings for whether end users can upload files directly during chat.</p>"
52215227
}
5228+
},
5229+
"qAppsConfiguration": {
5230+
"target": "com.amazonaws.qbusiness#QAppsConfiguration",
5231+
"traits": {
5232+
"smithy.api#documentation": "<p>Settings for whether end users can create and use Amazon Q Apps in the web experience.</p>"
5233+
}
52225234
}
52235235
},
52245236
"traits": {
@@ -9009,6 +9021,38 @@
90099021
"smithy.api#output": {}
90109022
}
90119023
},
9024+
"com.amazonaws.qbusiness#QAppsConfiguration": {
9025+
"type": "structure",
9026+
"members": {
9027+
"qAppsControlMode": {
9028+
"target": "com.amazonaws.qbusiness#QAppsControlMode",
9029+
"traits": {
9030+
"smithy.api#documentation": "<p>Status information about whether end users can create and use Amazon Q Apps in the web experience.</p>",
9031+
"smithy.api#required": {}
9032+
}
9033+
}
9034+
},
9035+
"traits": {
9036+
"smithy.api#documentation": "<p>Configuration information about Amazon Q Apps. (preview feature)</p>"
9037+
}
9038+
},
9039+
"com.amazonaws.qbusiness#QAppsControlMode": {
9040+
"type": "enum",
9041+
"members": {
9042+
"ENABLED": {
9043+
"target": "smithy.api#Unit",
9044+
"traits": {
9045+
"smithy.api#enumValue": "ENABLED"
9046+
}
9047+
},
9048+
"DISABLED": {
9049+
"target": "smithy.api#Unit",
9050+
"traits": {
9051+
"smithy.api#enumValue": "DISABLED"
9052+
}
9053+
}
9054+
}
9055+
},
90129056
"com.amazonaws.qbusiness#ReadAccessType": {
90139057
"type": "enum",
90149058
"members": {
@@ -10334,6 +10378,12 @@
1033410378
"traits": {
1033510379
"smithy.api#documentation": "<p>An option to allow end users to upload files directly during chat.</p>"
1033610380
}
10381+
},
10382+
"qAppsConfiguration": {
10383+
"target": "com.amazonaws.qbusiness#QAppsConfiguration",
10384+
"traits": {
10385+
"smithy.api#documentation": "<p>An option to allow end users to create and use Amazon Q Apps in the web experience.</p>"
10386+
}
1033710387
}
1033810388
},
1033910389
"traits": {

0 commit comments

Comments
 (0)