@aws-sdk/client-qapps 3.699.0 → 3.702.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 +56 -0
- package/dist-cjs/QApps.js +14 -0
- package/dist-cjs/commands/CreatePresignedUrlCommand.js +26 -0
- package/dist-cjs/commands/DescribeQAppPermissionsCommand.js +26 -0
- package/dist-cjs/commands/ExportQAppSessionDataCommand.js +26 -0
- package/dist-cjs/commands/GetQAppSessionMetadataCommand.js +26 -0
- package/dist-cjs/commands/ListQAppSessionDataCommand.js +26 -0
- package/dist-cjs/commands/UpdateQAppPermissionsCommand.js +26 -0
- package/dist-cjs/commands/UpdateQAppSessionMetadataCommand.js +26 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +24 -1
- package/dist-cjs/protocols/Aws_restJson1.js +352 -3
- package/dist-es/QApps.js +14 -0
- package/dist-es/commands/CreatePresignedUrlCommand.js +22 -0
- package/dist-es/commands/DescribeQAppPermissionsCommand.js +22 -0
- package/dist-es/commands/ExportQAppSessionDataCommand.js +22 -0
- package/dist-es/commands/GetQAppSessionMetadataCommand.js +22 -0
- package/dist-es/commands/ListQAppSessionDataCommand.js +22 -0
- package/dist-es/commands/UpdateQAppPermissionsCommand.js +22 -0
- package/dist-es/commands/UpdateQAppSessionMetadataCommand.js +22 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +23 -0
- package/dist-es/protocols/Aws_restJson1.js +336 -1
- package/dist-types/QApps.d.ts +49 -0
- package/dist-types/QAppsClient.d.ts +9 -2
- package/dist-types/commands/CreatePresignedUrlCommand.d.ts +161 -0
- package/dist-types/commands/CreateQAppCommand.d.ts +13 -4
- package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts +136 -0
- package/dist-types/commands/ExportQAppSessionDataCommand.d.ts +101 -0
- package/dist-types/commands/GetQAppCommand.d.ts +20 -4
- package/dist-types/commands/GetQAppSessionCommand.d.ts +13 -2
- package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts +128 -0
- package/dist-types/commands/ListQAppSessionDataCommand.d.ts +108 -0
- package/dist-types/commands/PredictQAppCommand.d.ts +13 -4
- package/dist-types/commands/StartQAppSessionCommand.d.ts +5 -0
- package/dist-types/commands/UpdateQAppCommand.d.ts +13 -4
- package/dist-types/commands/UpdateQAppPermissionsCommand.d.ts +187 -0
- package/dist-types/commands/UpdateQAppSessionCommand.d.ts +4 -0
- package/dist-types/commands/UpdateQAppSessionMetadataCommand.d.ts +138 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +704 -11
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/ts3.4/QApps.d.ts +119 -0
- package/dist-types/ts3.4/QAppsClient.d.ts +44 -2
- package/dist-types/ts3.4/commands/CreatePresignedUrlCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeQAppPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ExportQAppSessionDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetQAppSessionMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListQAppSessionDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateQAppPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateQAppSessionMetadataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +202 -5
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
- package/package.json +1 -1
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GetQAppSessionMetadataInput, GetQAppSessionMetadataOutput } from "../models/models_0";
|
|
4
|
+
import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetQAppSessionMetadataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetQAppSessionMetadataCommandInput extends GetQAppSessionMetadataInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetQAppSessionMetadataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetQAppSessionMetadataCommandOutput extends GetQAppSessionMetadataOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetQAppSessionMetadataCommand_base: {
|
|
25
|
+
new (input: GetQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppSessionMetadataCommandInput, GetQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<GetQAppSessionMetadataCommandInput, GetQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the current configuration of a Q App session.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QAppsClient, GetQAppSessionMetadataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
|
|
35
|
+
* // const { QAppsClient, GetQAppSessionMetadataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
|
|
36
|
+
* const client = new QAppsClient(config);
|
|
37
|
+
* const input = { // GetQAppSessionMetadataInput
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetQAppSessionMetadataCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetQAppSessionMetadataOutput
|
|
44
|
+
* // sessionId: "STRING_VALUE", // required
|
|
45
|
+
* // sessionArn: "STRING_VALUE", // required
|
|
46
|
+
* // sessionName: "STRING_VALUE",
|
|
47
|
+
* // sharingConfiguration: { // SessionSharingConfiguration
|
|
48
|
+
* // enabled: true || false, // required
|
|
49
|
+
* // acceptResponses: true || false,
|
|
50
|
+
* // revealCards: true || false,
|
|
51
|
+
* // },
|
|
52
|
+
* // sessionOwner: true || false,
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param GetQAppSessionMetadataCommandInput - {@link GetQAppSessionMetadataCommandInput}
|
|
58
|
+
* @returns {@link GetQAppSessionMetadataCommandOutput}
|
|
59
|
+
* @see {@link GetQAppSessionMetadataCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link GetQAppSessionMetadataCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>The client is not authorized to perform the requested operation.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>An internal service error occurred while processing the request.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
70
|
+
* <p>The requested resource could not be found.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
73
|
+
* <p>The requested operation could not be completed because
|
|
74
|
+
* it would exceed the service's quota or limit.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The requested operation could not be completed because too many
|
|
78
|
+
* requests were sent at once. Wait a bit and try again later.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
81
|
+
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ValidationException} (client fault)
|
|
84
|
+
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link QAppsServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
* @example Retrieves an existing session metadata for an Amazon Q App
|
|
91
|
+
* ```javascript
|
|
92
|
+
* //
|
|
93
|
+
* const input = {
|
|
94
|
+
* "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
95
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb"
|
|
96
|
+
* };
|
|
97
|
+
* const command = new GetQAppSessionMetadataCommand(input);
|
|
98
|
+
* const response = await client.send(command);
|
|
99
|
+
* /* response ==
|
|
100
|
+
* {
|
|
101
|
+
* "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
|
|
102
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
|
|
103
|
+
* "sessionName": "Trip itinerary collection session",
|
|
104
|
+
* "sessionOwner": true,
|
|
105
|
+
* "sharingConfiguration": {
|
|
106
|
+
* "acceptResponses": true,
|
|
107
|
+
* "enabled": true,
|
|
108
|
+
* "revealCards": false
|
|
109
|
+
* }
|
|
110
|
+
* }
|
|
111
|
+
* *\/
|
|
112
|
+
* // example id: example-1
|
|
113
|
+
* ```
|
|
114
|
+
*
|
|
115
|
+
*/
|
|
116
|
+
export declare class GetQAppSessionMetadataCommand extends GetQAppSessionMetadataCommand_base {
|
|
117
|
+
/** @internal type navigation helper, not in runtime. */
|
|
118
|
+
protected static __types: {
|
|
119
|
+
api: {
|
|
120
|
+
input: GetQAppSessionMetadataInput;
|
|
121
|
+
output: GetQAppSessionMetadataOutput;
|
|
122
|
+
};
|
|
123
|
+
sdk: {
|
|
124
|
+
input: GetQAppSessionMetadataCommandInput;
|
|
125
|
+
output: GetQAppSessionMetadataCommandOutput;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
}
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListQAppSessionDataInput, ListQAppSessionDataOutput } from "../models/models_0";
|
|
4
|
+
import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListQAppSessionDataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListQAppSessionDataCommandInput extends ListQAppSessionDataInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListQAppSessionDataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListQAppSessionDataCommandOutput extends ListQAppSessionDataOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListQAppSessionDataCommand_base: {
|
|
25
|
+
new (input: ListQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ListQAppSessionDataCommandInput, ListQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ListQAppSessionDataCommandInput, ListQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists the collected data of a Q App data collection session.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QAppsClient, ListQAppSessionDataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
|
|
35
|
+
* // const { QAppsClient, ListQAppSessionDataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
|
|
36
|
+
* const client = new QAppsClient(config);
|
|
37
|
+
* const input = { // ListQAppSessionDataInput
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListQAppSessionDataCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListQAppSessionDataOutput
|
|
44
|
+
* // sessionId: "STRING_VALUE", // required
|
|
45
|
+
* // sessionArn: "STRING_VALUE", // required
|
|
46
|
+
* // sessionData: [ // QAppSessionDataList
|
|
47
|
+
* // { // QAppSessionData
|
|
48
|
+
* // cardId: "STRING_VALUE", // required
|
|
49
|
+
* // value: "DOCUMENT_VALUE",
|
|
50
|
+
* // user: { // User
|
|
51
|
+
* // userId: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // submissionId: "STRING_VALUE",
|
|
54
|
+
* // timestamp: new Date("TIMESTAMP"),
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // nextToken: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param ListQAppSessionDataCommandInput - {@link ListQAppSessionDataCommandInput}
|
|
63
|
+
* @returns {@link ListQAppSessionDataCommandOutput}
|
|
64
|
+
* @see {@link ListQAppSessionDataCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link ListQAppSessionDataCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
+
* <p>The client is not authorized to perform the requested operation.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InternalServerException} (server fault)
|
|
72
|
+
* <p>An internal service error occurred while processing the request.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The requested resource could not be found.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
+
* <p>The requested operation could not be completed because
|
|
79
|
+
* it would exceed the service's quota or limit.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
82
|
+
* <p>The requested operation could not be completed because too many
|
|
83
|
+
* requests were sent at once. Wait a bit and try again later.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
86
|
+
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ValidationException} (client fault)
|
|
89
|
+
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link QAppsServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class ListQAppSessionDataCommand extends ListQAppSessionDataCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: ListQAppSessionDataInput;
|
|
101
|
+
output: ListQAppSessionDataOutput;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: ListQAppSessionDataCommandInput;
|
|
105
|
+
output: ListQAppSessionDataCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -61,14 +61,14 @@ declare const PredictQAppCommand_base: {
|
|
|
61
61
|
* // textInput: { // TextInputCardInput
|
|
62
62
|
* // title: "STRING_VALUE", // required
|
|
63
63
|
* // id: "STRING_VALUE", // required
|
|
64
|
-
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
64
|
+
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
65
65
|
* // placeholder: "STRING_VALUE",
|
|
66
66
|
* // defaultValue: "STRING_VALUE",
|
|
67
67
|
* // },
|
|
68
68
|
* // qQuery: { // QQueryCardInput
|
|
69
69
|
* // title: "STRING_VALUE", // required
|
|
70
70
|
* // id: "STRING_VALUE", // required
|
|
71
|
-
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
71
|
+
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
72
72
|
* // prompt: "STRING_VALUE", // required
|
|
73
73
|
* // outputSource: "approved-sources" || "llm",
|
|
74
74
|
* // attributeFilter: { // AttributeFilter
|
|
@@ -156,18 +156,27 @@ declare const PredictQAppCommand_base: {
|
|
|
156
156
|
* // qPlugin: { // QPluginCardInput
|
|
157
157
|
* // title: "STRING_VALUE", // required
|
|
158
158
|
* // id: "STRING_VALUE", // required
|
|
159
|
-
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
159
|
+
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
160
160
|
* // prompt: "STRING_VALUE", // required
|
|
161
161
|
* // pluginId: "STRING_VALUE", // required
|
|
162
162
|
* // },
|
|
163
163
|
* // fileUpload: { // FileUploadCardInput
|
|
164
164
|
* // title: "STRING_VALUE", // required
|
|
165
165
|
* // id: "STRING_VALUE", // required
|
|
166
|
-
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
166
|
+
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
167
167
|
* // filename: "STRING_VALUE",
|
|
168
168
|
* // fileId: "STRING_VALUE",
|
|
169
169
|
* // allowOverride: true || false,
|
|
170
170
|
* // },
|
|
171
|
+
* // formInput: { // FormInputCardInput
|
|
172
|
+
* // title: "STRING_VALUE", // required
|
|
173
|
+
* // id: "STRING_VALUE", // required
|
|
174
|
+
* // type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
175
|
+
* // metadata: { // FormInputCardMetadata
|
|
176
|
+
* // schema: "DOCUMENT_VALUE", // required
|
|
177
|
+
* // },
|
|
178
|
+
* // computeMode: "append" || "replace",
|
|
179
|
+
* // },
|
|
171
180
|
* // },
|
|
172
181
|
* // ],
|
|
173
182
|
* // initialPrompt: "STRING_VALUE",
|
|
@@ -47,8 +47,13 @@ declare const StartQAppSessionCommand_base: {
|
|
|
47
47
|
* { // CardValue
|
|
48
48
|
* cardId: "STRING_VALUE", // required
|
|
49
49
|
* value: "STRING_VALUE", // required
|
|
50
|
+
* submissionMutation: { // SubmissionMutation
|
|
51
|
+
* submissionId: "STRING_VALUE", // required
|
|
52
|
+
* mutationType: "edit" || "delete" || "add", // required
|
|
53
|
+
* },
|
|
50
54
|
* },
|
|
51
55
|
* ],
|
|
56
|
+
* sessionId: "STRING_VALUE",
|
|
52
57
|
* tags: { // TagMap
|
|
53
58
|
* "<keys>": "STRING_VALUE",
|
|
54
59
|
* },
|
|
@@ -45,14 +45,14 @@ declare const UpdateQAppCommand_base: {
|
|
|
45
45
|
* textInput: { // TextInputCardInput
|
|
46
46
|
* title: "STRING_VALUE", // required
|
|
47
47
|
* id: "STRING_VALUE", // required
|
|
48
|
-
* type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
48
|
+
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
49
49
|
* placeholder: "STRING_VALUE",
|
|
50
50
|
* defaultValue: "STRING_VALUE",
|
|
51
51
|
* },
|
|
52
52
|
* qQuery: { // QQueryCardInput
|
|
53
53
|
* title: "STRING_VALUE", // required
|
|
54
54
|
* id: "STRING_VALUE", // required
|
|
55
|
-
* type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
55
|
+
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
56
56
|
* prompt: "STRING_VALUE", // required
|
|
57
57
|
* outputSource: "approved-sources" || "llm",
|
|
58
58
|
* attributeFilter: { // AttributeFilter
|
|
@@ -140,18 +140,27 @@ declare const UpdateQAppCommand_base: {
|
|
|
140
140
|
* qPlugin: { // QPluginCardInput
|
|
141
141
|
* title: "STRING_VALUE", // required
|
|
142
142
|
* id: "STRING_VALUE", // required
|
|
143
|
-
* type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
143
|
+
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
144
144
|
* prompt: "STRING_VALUE", // required
|
|
145
145
|
* pluginId: "STRING_VALUE", // required
|
|
146
146
|
* },
|
|
147
147
|
* fileUpload: { // FileUploadCardInput
|
|
148
148
|
* title: "STRING_VALUE", // required
|
|
149
149
|
* id: "STRING_VALUE", // required
|
|
150
|
-
* type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
|
|
150
|
+
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
151
151
|
* filename: "STRING_VALUE",
|
|
152
152
|
* fileId: "STRING_VALUE",
|
|
153
153
|
* allowOverride: true || false,
|
|
154
154
|
* },
|
|
155
|
+
* formInput: { // FormInputCardInput
|
|
156
|
+
* title: "STRING_VALUE", // required
|
|
157
|
+
* id: "STRING_VALUE", // required
|
|
158
|
+
* type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
|
|
159
|
+
* metadata: { // FormInputCardMetadata
|
|
160
|
+
* schema: "DOCUMENT_VALUE", // required
|
|
161
|
+
* },
|
|
162
|
+
* computeMode: "append" || "replace",
|
|
163
|
+
* },
|
|
155
164
|
* },
|
|
156
165
|
* ],
|
|
157
166
|
* initialPrompt: "STRING_VALUE",
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateQAppPermissionsInput, UpdateQAppPermissionsOutput } from "../models/models_0";
|
|
4
|
+
import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateQAppPermissionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateQAppPermissionsCommandInput extends UpdateQAppPermissionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateQAppPermissionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateQAppPermissionsCommandOutput extends UpdateQAppPermissionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateQAppPermissionsCommand_base: {
|
|
25
|
+
new (input: UpdateQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppPermissionsCommandInput, UpdateQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppPermissionsCommandInput, UpdateQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QAppsClient, UpdateQAppPermissionsCommand } from "@aws-sdk/client-qapps"; // ES Modules import
|
|
35
|
+
* // const { QAppsClient, UpdateQAppPermissionsCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
|
|
36
|
+
* const client = new QAppsClient(config);
|
|
37
|
+
* const input = { // UpdateQAppPermissionsInput
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* appId: "STRING_VALUE", // required
|
|
40
|
+
* grantPermissions: [ // PermissionsInputList
|
|
41
|
+
* { // PermissionInput
|
|
42
|
+
* action: "read" || "write", // required
|
|
43
|
+
* principal: "STRING_VALUE", // required
|
|
44
|
+
* },
|
|
45
|
+
* ],
|
|
46
|
+
* revokePermissions: [
|
|
47
|
+
* {
|
|
48
|
+
* action: "read" || "write", // required
|
|
49
|
+
* principal: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* ],
|
|
52
|
+
* };
|
|
53
|
+
* const command = new UpdateQAppPermissionsCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // { // UpdateQAppPermissionsOutput
|
|
56
|
+
* // resourceArn: "STRING_VALUE",
|
|
57
|
+
* // appId: "STRING_VALUE",
|
|
58
|
+
* // permissions: [ // PermissionsOutputList
|
|
59
|
+
* // { // PermissionOutput
|
|
60
|
+
* // action: "read" || "write", // required
|
|
61
|
+
* // principal: { // PrincipalOutput
|
|
62
|
+
* // userId: "STRING_VALUE",
|
|
63
|
+
* // userType: "owner" || "user",
|
|
64
|
+
* // email: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param UpdateQAppPermissionsCommandInput - {@link UpdateQAppPermissionsCommandInput}
|
|
73
|
+
* @returns {@link UpdateQAppPermissionsCommandOutput}
|
|
74
|
+
* @see {@link UpdateQAppPermissionsCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link UpdateQAppPermissionsCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
+
* <p>The client is not authorized to perform the requested operation.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerException} (server fault)
|
|
82
|
+
* <p>An internal service error occurred while processing the request.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
85
|
+
* <p>The requested resource could not be found.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>The requested operation could not be completed because too many
|
|
89
|
+
* requests were sent at once. Wait a bit and try again later.</p>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
92
|
+
* <p>The client is not authenticated or authorized to perform the requested operation.</p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
* <p>The input failed to satisfy the constraints specified by the service.</p>
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link QAppsServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from QApps service.</p>
|
|
99
|
+
*
|
|
100
|
+
* @public
|
|
101
|
+
* @example Grant permissions for the app
|
|
102
|
+
* ```javascript
|
|
103
|
+
* //
|
|
104
|
+
* const input = {
|
|
105
|
+
* "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
106
|
+
* "grantPermissions": [
|
|
107
|
+
* {
|
|
108
|
+
* "action": "read",
|
|
109
|
+
* "principal": "user2@example.com"
|
|
110
|
+
* }
|
|
111
|
+
* ],
|
|
112
|
+
* "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
|
|
113
|
+
* };
|
|
114
|
+
* const command = new UpdateQAppPermissionsCommand(input);
|
|
115
|
+
* const response = await client.send(command);
|
|
116
|
+
* /* response ==
|
|
117
|
+
* {
|
|
118
|
+
* "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
119
|
+
* "permissions": [
|
|
120
|
+
* {
|
|
121
|
+
* "action": "write",
|
|
122
|
+
* "principal": {
|
|
123
|
+
* "email": "user1@example.com",
|
|
124
|
+
* "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
|
|
125
|
+
* }
|
|
126
|
+
* },
|
|
127
|
+
* {
|
|
128
|
+
* "action": "read",
|
|
129
|
+
* "principal": {
|
|
130
|
+
* "email": "user2@example.com",
|
|
131
|
+
* "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* ],
|
|
135
|
+
* "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
|
|
136
|
+
* }
|
|
137
|
+
* *\/
|
|
138
|
+
* // example id: example-1
|
|
139
|
+
* ```
|
|
140
|
+
*
|
|
141
|
+
* @example Revoke permissions for the app
|
|
142
|
+
* ```javascript
|
|
143
|
+
* //
|
|
144
|
+
* const input = {
|
|
145
|
+
* "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
146
|
+
* "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2",
|
|
147
|
+
* "revokePermissions": [
|
|
148
|
+
* {
|
|
149
|
+
* "action": "read",
|
|
150
|
+
* "principal": "user2@example.com"
|
|
151
|
+
* }
|
|
152
|
+
* ]
|
|
153
|
+
* };
|
|
154
|
+
* const command = new UpdateQAppPermissionsCommand(input);
|
|
155
|
+
* const response = await client.send(command);
|
|
156
|
+
* /* response ==
|
|
157
|
+
* {
|
|
158
|
+
* "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
|
|
159
|
+
* "permissions": [
|
|
160
|
+
* {
|
|
161
|
+
* "action": "write",
|
|
162
|
+
* "principal": {
|
|
163
|
+
* "email": "user1@example.com",
|
|
164
|
+
* "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
|
|
165
|
+
* }
|
|
166
|
+
* }
|
|
167
|
+
* ],
|
|
168
|
+
* "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
|
|
169
|
+
* }
|
|
170
|
+
* *\/
|
|
171
|
+
* // example id: example-2
|
|
172
|
+
* ```
|
|
173
|
+
*
|
|
174
|
+
*/
|
|
175
|
+
export declare class UpdateQAppPermissionsCommand extends UpdateQAppPermissionsCommand_base {
|
|
176
|
+
/** @internal type navigation helper, not in runtime. */
|
|
177
|
+
protected static __types: {
|
|
178
|
+
api: {
|
|
179
|
+
input: UpdateQAppPermissionsInput;
|
|
180
|
+
output: UpdateQAppPermissionsOutput;
|
|
181
|
+
};
|
|
182
|
+
sdk: {
|
|
183
|
+
input: UpdateQAppPermissionsCommandInput;
|
|
184
|
+
output: UpdateQAppPermissionsCommandOutput;
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
}
|
|
@@ -45,6 +45,10 @@ declare const UpdateQAppSessionCommand_base: {
|
|
|
45
45
|
* { // CardValue
|
|
46
46
|
* cardId: "STRING_VALUE", // required
|
|
47
47
|
* value: "STRING_VALUE", // required
|
|
48
|
+
* submissionMutation: { // SubmissionMutation
|
|
49
|
+
* submissionId: "STRING_VALUE", // required
|
|
50
|
+
* mutationType: "edit" || "delete" || "add", // required
|
|
51
|
+
* },
|
|
48
52
|
* },
|
|
49
53
|
* ],
|
|
50
54
|
* };
|