@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,138 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { UpdateQAppSessionMetadataInput, UpdateQAppSessionMetadataOutput } 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 UpdateQAppSessionMetadataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateQAppSessionMetadataCommandInput extends UpdateQAppSessionMetadataInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateQAppSessionMetadataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateQAppSessionMetadataCommandOutput extends UpdateQAppSessionMetadataOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateQAppSessionMetadataCommand_base: {
|
|
25
|
+
new (input: UpdateQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionMetadataCommandInput, UpdateQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionMetadataCommandInput, UpdateQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the configuration metadata of a session for a given Q App <code>sessionId</code>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { QAppsClient, UpdateQAppSessionMetadataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
|
|
35
|
+
* // const { QAppsClient, UpdateQAppSessionMetadataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
|
|
36
|
+
* const client = new QAppsClient(config);
|
|
37
|
+
* const input = { // UpdateQAppSessionMetadataInput
|
|
38
|
+
* instanceId: "STRING_VALUE", // required
|
|
39
|
+
* sessionId: "STRING_VALUE", // required
|
|
40
|
+
* sessionName: "STRING_VALUE",
|
|
41
|
+
* sharingConfiguration: { // SessionSharingConfiguration
|
|
42
|
+
* enabled: true || false, // required
|
|
43
|
+
* acceptResponses: true || false,
|
|
44
|
+
* revealCards: true || false,
|
|
45
|
+
* },
|
|
46
|
+
* };
|
|
47
|
+
* const command = new UpdateQAppSessionMetadataCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // UpdateQAppSessionMetadataOutput
|
|
50
|
+
* // sessionId: "STRING_VALUE", // required
|
|
51
|
+
* // sessionArn: "STRING_VALUE", // required
|
|
52
|
+
* // sessionName: "STRING_VALUE",
|
|
53
|
+
* // sharingConfiguration: { // SessionSharingConfiguration
|
|
54
|
+
* // enabled: true || false, // required
|
|
55
|
+
* // acceptResponses: true || false,
|
|
56
|
+
* // revealCards: true || false,
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param UpdateQAppSessionMetadataCommandInput - {@link UpdateQAppSessionMetadataCommandInput}
|
|
63
|
+
* @returns {@link UpdateQAppSessionMetadataCommandOutput}
|
|
64
|
+
* @see {@link UpdateQAppSessionMetadataCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link UpdateQAppSessionMetadataCommandOutput} 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
|
+
* @example Updates an existing session metadata for an Amazon Q App
|
|
96
|
+
* ```javascript
|
|
97
|
+
* //
|
|
98
|
+
* const input = {
|
|
99
|
+
* "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
|
|
100
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
|
|
101
|
+
* "sessionName": "Trip itinerary collection session",
|
|
102
|
+
* "sharingConfiguration": {
|
|
103
|
+
* "acceptResponses": true,
|
|
104
|
+
* "enabled": true,
|
|
105
|
+
* "revealCards": false
|
|
106
|
+
* }
|
|
107
|
+
* };
|
|
108
|
+
* const command = new UpdateQAppSessionMetadataCommand(input);
|
|
109
|
+
* const response = await client.send(command);
|
|
110
|
+
* /* response ==
|
|
111
|
+
* {
|
|
112
|
+
* "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",
|
|
113
|
+
* "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
|
|
114
|
+
* "sessionName": "Trip itinerary collection session",
|
|
115
|
+
* "sharingConfiguration": {
|
|
116
|
+
* "acceptResponses": true,
|
|
117
|
+
* "enabled": true,
|
|
118
|
+
* "revealCards": false
|
|
119
|
+
* }
|
|
120
|
+
* }
|
|
121
|
+
* *\/
|
|
122
|
+
* // example id: example-1
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
125
|
+
*/
|
|
126
|
+
export declare class UpdateQAppSessionMetadataCommand extends UpdateQAppSessionMetadataCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: UpdateQAppSessionMetadataInput;
|
|
131
|
+
output: UpdateQAppSessionMetadataOutput;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: UpdateQAppSessionMetadataCommandInput;
|
|
135
|
+
output: UpdateQAppSessionMetadataCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -4,17 +4,22 @@ export * from "./BatchCreateCategoryCommand";
|
|
|
4
4
|
export * from "./BatchDeleteCategoryCommand";
|
|
5
5
|
export * from "./BatchUpdateCategoryCommand";
|
|
6
6
|
export * from "./CreateLibraryItemCommand";
|
|
7
|
+
export * from "./CreatePresignedUrlCommand";
|
|
7
8
|
export * from "./CreateQAppCommand";
|
|
8
9
|
export * from "./DeleteLibraryItemCommand";
|
|
9
10
|
export * from "./DeleteQAppCommand";
|
|
11
|
+
export * from "./DescribeQAppPermissionsCommand";
|
|
10
12
|
export * from "./DisassociateLibraryItemReviewCommand";
|
|
11
13
|
export * from "./DisassociateQAppFromUserCommand";
|
|
14
|
+
export * from "./ExportQAppSessionDataCommand";
|
|
12
15
|
export * from "./GetLibraryItemCommand";
|
|
13
16
|
export * from "./GetQAppCommand";
|
|
14
17
|
export * from "./GetQAppSessionCommand";
|
|
18
|
+
export * from "./GetQAppSessionMetadataCommand";
|
|
15
19
|
export * from "./ImportDocumentCommand";
|
|
16
20
|
export * from "./ListCategoriesCommand";
|
|
17
21
|
export * from "./ListLibraryItemsCommand";
|
|
22
|
+
export * from "./ListQAppSessionDataCommand";
|
|
18
23
|
export * from "./ListQAppsCommand";
|
|
19
24
|
export * from "./ListTagsForResourceCommand";
|
|
20
25
|
export * from "./PredictQAppCommand";
|
|
@@ -25,4 +30,6 @@ export * from "./UntagResourceCommand";
|
|
|
25
30
|
export * from "./UpdateLibraryItemCommand";
|
|
26
31
|
export * from "./UpdateLibraryItemMetadataCommand";
|
|
27
32
|
export * from "./UpdateQAppCommand";
|
|
33
|
+
export * from "./UpdateQAppPermissionsCommand";
|
|
28
34
|
export * from "./UpdateQAppSessionCommand";
|
|
35
|
+
export * from "./UpdateQAppSessionMetadataCommand";
|