@aws-sdk/client-qapps 3.682.0 → 3.686.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.
Files changed (38) hide show
  1. package/README.md +33 -1
  2. package/dist-cjs/QApps.js +8 -0
  3. package/dist-cjs/commands/BatchCreateCategoryCommand.js +26 -0
  4. package/dist-cjs/commands/BatchDeleteCategoryCommand.js +26 -0
  5. package/dist-cjs/commands/BatchUpdateCategoryCommand.js +26 -0
  6. package/dist-cjs/commands/ListCategoriesCommand.js +26 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/protocols/Aws_restJson1.js +106 -1
  9. package/dist-es/QApps.js +8 -0
  10. package/dist-es/commands/BatchCreateCategoryCommand.js +22 -0
  11. package/dist-es/commands/BatchDeleteCategoryCommand.js +22 -0
  12. package/dist-es/commands/BatchUpdateCategoryCommand.js +22 -0
  13. package/dist-es/commands/ListCategoriesCommand.js +22 -0
  14. package/dist-es/commands/index.js +4 -0
  15. package/dist-es/protocols/Aws_restJson1.js +96 -0
  16. package/dist-types/QApps.d.ts +28 -0
  17. package/dist-types/QAppsClient.d.ts +6 -2
  18. package/dist-types/commands/BatchCreateCategoryCommand.d.ts +120 -0
  19. package/dist-types/commands/BatchDeleteCategoryCommand.d.ts +109 -0
  20. package/dist-types/commands/BatchUpdateCategoryCommand.d.ts +120 -0
  21. package/dist-types/commands/GetLibraryItemCommand.d.ts +2 -0
  22. package/dist-types/commands/GetQAppSessionCommand.d.ts +2 -2
  23. package/dist-types/commands/ListCategoriesCommand.d.ts +126 -0
  24. package/dist-types/commands/ListLibraryItemsCommand.d.ts +2 -0
  25. package/dist-types/commands/UpdateLibraryItemCommand.d.ts +2 -0
  26. package/dist-types/commands/index.d.ts +4 -0
  27. package/dist-types/models/models_0.d.ts +117 -0
  28. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  29. package/dist-types/ts3.4/QApps.d.ts +68 -0
  30. package/dist-types/ts3.4/QAppsClient.d.ts +24 -0
  31. package/dist-types/ts3.4/commands/BatchCreateCategoryCommand.d.ts +46 -0
  32. package/dist-types/ts3.4/commands/BatchDeleteCategoryCommand.d.ts +46 -0
  33. package/dist-types/ts3.4/commands/BatchUpdateCategoryCommand.d.ts +46 -0
  34. package/dist-types/ts3.4/commands/ListCategoriesCommand.d.ts +47 -0
  35. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  36. package/dist-types/ts3.4/models/models_0.d.ts +30 -0
  37. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  38. package/package.json +35 -35
@@ -1,6 +1,9 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
2
  import { AssociateLibraryItemReviewCommandInput, AssociateLibraryItemReviewCommandOutput } from "./commands/AssociateLibraryItemReviewCommand";
3
3
  import { AssociateQAppWithUserCommandInput, AssociateQAppWithUserCommandOutput } from "./commands/AssociateQAppWithUserCommand";
4
+ import { BatchCreateCategoryCommandInput, BatchCreateCategoryCommandOutput } from "./commands/BatchCreateCategoryCommand";
5
+ import { BatchDeleteCategoryCommandInput, BatchDeleteCategoryCommandOutput } from "./commands/BatchDeleteCategoryCommand";
6
+ import { BatchUpdateCategoryCommandInput, BatchUpdateCategoryCommandOutput } from "./commands/BatchUpdateCategoryCommand";
4
7
  import { CreateLibraryItemCommandInput, CreateLibraryItemCommandOutput } from "./commands/CreateLibraryItemCommand";
5
8
  import { CreateQAppCommandInput, CreateQAppCommandOutput } from "./commands/CreateQAppCommand";
6
9
  import { DeleteLibraryItemCommandInput, DeleteLibraryItemCommandOutput } from "./commands/DeleteLibraryItemCommand";
@@ -11,6 +14,7 @@ import { GetLibraryItemCommandInput, GetLibraryItemCommandOutput } from "./comma
11
14
  import { GetQAppCommandInput, GetQAppCommandOutput } from "./commands/GetQAppCommand";
12
15
  import { GetQAppSessionCommandInput, GetQAppSessionCommandOutput } from "./commands/GetQAppSessionCommand";
13
16
  import { ImportDocumentCommandInput, ImportDocumentCommandOutput } from "./commands/ImportDocumentCommand";
17
+ import { ListCategoriesCommandInput, ListCategoriesCommandOutput } from "./commands/ListCategoriesCommand";
14
18
  import { ListLibraryItemsCommandInput, ListLibraryItemsCommandOutput } from "./commands/ListLibraryItemsCommand";
15
19
  import { ListQAppsCommandInput, ListQAppsCommandOutput } from "./commands/ListQAppsCommand";
16
20
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
@@ -37,6 +41,24 @@ export interface QApps {
37
41
  associateQAppWithUser(args: AssociateQAppWithUserCommandInput, options?: __HttpHandlerOptions): Promise<AssociateQAppWithUserCommandOutput>;
38
42
  associateQAppWithUser(args: AssociateQAppWithUserCommandInput, cb: (err: any, data?: AssociateQAppWithUserCommandOutput) => void): void;
39
43
  associateQAppWithUser(args: AssociateQAppWithUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateQAppWithUserCommandOutput) => void): void;
44
+ /**
45
+ * @see {@link BatchCreateCategoryCommand}
46
+ */
47
+ batchCreateCategory(args: BatchCreateCategoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateCategoryCommandOutput>;
48
+ batchCreateCategory(args: BatchCreateCategoryCommandInput, cb: (err: any, data?: BatchCreateCategoryCommandOutput) => void): void;
49
+ batchCreateCategory(args: BatchCreateCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateCategoryCommandOutput) => void): void;
50
+ /**
51
+ * @see {@link BatchDeleteCategoryCommand}
52
+ */
53
+ batchDeleteCategory(args: BatchDeleteCategoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchDeleteCategoryCommandOutput>;
54
+ batchDeleteCategory(args: BatchDeleteCategoryCommandInput, cb: (err: any, data?: BatchDeleteCategoryCommandOutput) => void): void;
55
+ batchDeleteCategory(args: BatchDeleteCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteCategoryCommandOutput) => void): void;
56
+ /**
57
+ * @see {@link BatchUpdateCategoryCommand}
58
+ */
59
+ batchUpdateCategory(args: BatchUpdateCategoryCommandInput, options?: __HttpHandlerOptions): Promise<BatchUpdateCategoryCommandOutput>;
60
+ batchUpdateCategory(args: BatchUpdateCategoryCommandInput, cb: (err: any, data?: BatchUpdateCategoryCommandOutput) => void): void;
61
+ batchUpdateCategory(args: BatchUpdateCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchUpdateCategoryCommandOutput) => void): void;
40
62
  /**
41
63
  * @see {@link CreateLibraryItemCommand}
42
64
  */
@@ -97,6 +119,12 @@ export interface QApps {
97
119
  importDocument(args: ImportDocumentCommandInput, options?: __HttpHandlerOptions): Promise<ImportDocumentCommandOutput>;
98
120
  importDocument(args: ImportDocumentCommandInput, cb: (err: any, data?: ImportDocumentCommandOutput) => void): void;
99
121
  importDocument(args: ImportDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportDocumentCommandOutput) => void): void;
122
+ /**
123
+ * @see {@link ListCategoriesCommand}
124
+ */
125
+ listCategories(args: ListCategoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListCategoriesCommandOutput>;
126
+ listCategories(args: ListCategoriesCommandInput, cb: (err: any, data?: ListCategoriesCommandOutput) => void): void;
127
+ listCategories(args: ListCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCategoriesCommandOutput) => void): void;
100
128
  /**
101
129
  * @see {@link ListLibraryItemsCommand}
102
130
  */
@@ -9,6 +9,9 @@ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalc
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
10
  import { AssociateLibraryItemReviewCommandInput, AssociateLibraryItemReviewCommandOutput } from "./commands/AssociateLibraryItemReviewCommand";
11
11
  import { AssociateQAppWithUserCommandInput, AssociateQAppWithUserCommandOutput } from "./commands/AssociateQAppWithUserCommand";
12
+ import { BatchCreateCategoryCommandInput, BatchCreateCategoryCommandOutput } from "./commands/BatchCreateCategoryCommand";
13
+ import { BatchDeleteCategoryCommandInput, BatchDeleteCategoryCommandOutput } from "./commands/BatchDeleteCategoryCommand";
14
+ import { BatchUpdateCategoryCommandInput, BatchUpdateCategoryCommandOutput } from "./commands/BatchUpdateCategoryCommand";
12
15
  import { CreateLibraryItemCommandInput, CreateLibraryItemCommandOutput } from "./commands/CreateLibraryItemCommand";
13
16
  import { CreateQAppCommandInput, CreateQAppCommandOutput } from "./commands/CreateQAppCommand";
14
17
  import { DeleteLibraryItemCommandInput, DeleteLibraryItemCommandOutput } from "./commands/DeleteLibraryItemCommand";
@@ -19,6 +22,7 @@ import { GetLibraryItemCommandInput, GetLibraryItemCommandOutput } from "./comma
19
22
  import { GetQAppCommandInput, GetQAppCommandOutput } from "./commands/GetQAppCommand";
20
23
  import { GetQAppSessionCommandInput, GetQAppSessionCommandOutput } from "./commands/GetQAppSessionCommand";
21
24
  import { ImportDocumentCommandInput, ImportDocumentCommandOutput } from "./commands/ImportDocumentCommand";
25
+ import { ListCategoriesCommandInput, ListCategoriesCommandOutput } from "./commands/ListCategoriesCommand";
22
26
  import { ListLibraryItemsCommandInput, ListLibraryItemsCommandOutput } from "./commands/ListLibraryItemsCommand";
23
27
  import { ListQAppsCommandInput, ListQAppsCommandOutput } from "./commands/ListQAppsCommand";
24
28
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
@@ -37,11 +41,11 @@ export { __Client };
37
41
  /**
38
42
  * @public
39
43
  */
40
- export type ServiceInputTypes = AssociateLibraryItemReviewCommandInput | AssociateQAppWithUserCommandInput | CreateLibraryItemCommandInput | CreateQAppCommandInput | DeleteLibraryItemCommandInput | DeleteQAppCommandInput | DisassociateLibraryItemReviewCommandInput | DisassociateQAppFromUserCommandInput | GetLibraryItemCommandInput | GetQAppCommandInput | GetQAppSessionCommandInput | ImportDocumentCommandInput | ListLibraryItemsCommandInput | ListQAppsCommandInput | ListTagsForResourceCommandInput | PredictQAppCommandInput | StartQAppSessionCommandInput | StopQAppSessionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateLibraryItemCommandInput | UpdateLibraryItemMetadataCommandInput | UpdateQAppCommandInput | UpdateQAppSessionCommandInput;
44
+ export type ServiceInputTypes = AssociateLibraryItemReviewCommandInput | AssociateQAppWithUserCommandInput | BatchCreateCategoryCommandInput | BatchDeleteCategoryCommandInput | BatchUpdateCategoryCommandInput | CreateLibraryItemCommandInput | CreateQAppCommandInput | DeleteLibraryItemCommandInput | DeleteQAppCommandInput | DisassociateLibraryItemReviewCommandInput | DisassociateQAppFromUserCommandInput | GetLibraryItemCommandInput | GetQAppCommandInput | GetQAppSessionCommandInput | ImportDocumentCommandInput | ListCategoriesCommandInput | ListLibraryItemsCommandInput | ListQAppsCommandInput | ListTagsForResourceCommandInput | PredictQAppCommandInput | StartQAppSessionCommandInput | StopQAppSessionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateLibraryItemCommandInput | UpdateLibraryItemMetadataCommandInput | UpdateQAppCommandInput | UpdateQAppSessionCommandInput;
41
45
  /**
42
46
  * @public
43
47
  */
44
- export type ServiceOutputTypes = AssociateLibraryItemReviewCommandOutput | AssociateQAppWithUserCommandOutput | CreateLibraryItemCommandOutput | CreateQAppCommandOutput | DeleteLibraryItemCommandOutput | DeleteQAppCommandOutput | DisassociateLibraryItemReviewCommandOutput | DisassociateQAppFromUserCommandOutput | GetLibraryItemCommandOutput | GetQAppCommandOutput | GetQAppSessionCommandOutput | ImportDocumentCommandOutput | ListLibraryItemsCommandOutput | ListQAppsCommandOutput | ListTagsForResourceCommandOutput | PredictQAppCommandOutput | StartQAppSessionCommandOutput | StopQAppSessionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateLibraryItemCommandOutput | UpdateLibraryItemMetadataCommandOutput | UpdateQAppCommandOutput | UpdateQAppSessionCommandOutput;
48
+ export type ServiceOutputTypes = AssociateLibraryItemReviewCommandOutput | AssociateQAppWithUserCommandOutput | BatchCreateCategoryCommandOutput | BatchDeleteCategoryCommandOutput | BatchUpdateCategoryCommandOutput | CreateLibraryItemCommandOutput | CreateQAppCommandOutput | DeleteLibraryItemCommandOutput | DeleteQAppCommandOutput | DisassociateLibraryItemReviewCommandOutput | DisassociateQAppFromUserCommandOutput | GetLibraryItemCommandOutput | GetQAppCommandOutput | GetQAppSessionCommandOutput | ImportDocumentCommandOutput | ListCategoriesCommandOutput | ListLibraryItemsCommandOutput | ListQAppsCommandOutput | ListTagsForResourceCommandOutput | PredictQAppCommandOutput | StartQAppSessionCommandOutput | StopQAppSessionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateLibraryItemCommandOutput | UpdateLibraryItemMetadataCommandOutput | UpdateQAppCommandOutput | UpdateQAppSessionCommandOutput;
45
49
  /**
46
50
  * @public
47
51
  */
@@ -0,0 +1,120 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BatchCreateCategoryInput } 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 BatchCreateCategoryCommand}.
14
+ */
15
+ export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchCreateCategoryCommand}.
21
+ */
22
+ export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const BatchCreateCategoryCommand_base: {
25
+ new (input: BatchCreateCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchCreateCategoryCommandInput, BatchCreateCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: BatchCreateCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchCreateCategoryCommandInput, BatchCreateCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, BatchCreateCategoryCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, BatchCreateCategoryCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // BatchCreateCategoryInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * categories: [ // BatchCreateCategoryInputCategoryList // required
40
+ * { // BatchCreateCategoryInputCategory
41
+ * id: "STRING_VALUE",
42
+ * title: "STRING_VALUE", // required
43
+ * color: "STRING_VALUE",
44
+ * },
45
+ * ],
46
+ * };
47
+ * const command = new BatchCreateCategoryCommand(input);
48
+ * const response = await client.send(command);
49
+ * // {};
50
+ *
51
+ * ```
52
+ *
53
+ * @param BatchCreateCategoryCommandInput - {@link BatchCreateCategoryCommandInput}
54
+ * @returns {@link BatchCreateCategoryCommandOutput}
55
+ * @see {@link BatchCreateCategoryCommandInput} for command's `input` shape.
56
+ * @see {@link BatchCreateCategoryCommandOutput} for command's `response` shape.
57
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>The client is not authorized to perform the requested operation.</p>
61
+ *
62
+ * @throws {@link ConflictException} (client fault)
63
+ * <p>The requested operation could not be completed due to a
64
+ * conflict with the current state of the resource.</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 ThrottlingException} (client fault)
73
+ * <p>The requested operation could not be completed because too many
74
+ * requests were sent at once. Wait a bit and try again later.</p>
75
+ *
76
+ * @throws {@link UnauthorizedException} (client fault)
77
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
81
+ *
82
+ * @throws {@link QAppsServiceException}
83
+ * <p>Base exception class for all service exceptions from QApps service.</p>
84
+ *
85
+ * @public
86
+ * @example Creates the categories for the library
87
+ * ```javascript
88
+ * //
89
+ * const input = {
90
+ * "categories": [
91
+ * {
92
+ * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
93
+ * "title": "HR"
94
+ * },
95
+ * {
96
+ * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
97
+ * "title": "Marketing"
98
+ * }
99
+ * ],
100
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
101
+ * };
102
+ * const command = new BatchCreateCategoryCommand(input);
103
+ * await client.send(command);
104
+ * // example id: example-1
105
+ * ```
106
+ *
107
+ */
108
+ export declare class BatchCreateCategoryCommand extends BatchCreateCategoryCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: BatchCreateCategoryInput;
113
+ output: {};
114
+ };
115
+ sdk: {
116
+ input: BatchCreateCategoryCommandInput;
117
+ output: BatchCreateCategoryCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -0,0 +1,109 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BatchDeleteCategoryInput } 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 BatchDeleteCategoryCommand}.
14
+ */
15
+ export interface BatchDeleteCategoryCommandInput extends BatchDeleteCategoryInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchDeleteCategoryCommand}.
21
+ */
22
+ export interface BatchDeleteCategoryCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const BatchDeleteCategoryCommand_base: {
25
+ new (input: BatchDeleteCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteCategoryCommandInput, BatchDeleteCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: BatchDeleteCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchDeleteCategoryCommandInput, BatchDeleteCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, BatchDeleteCategoryCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, BatchDeleteCategoryCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // BatchDeleteCategoryInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * categories: [ // DeleteCategoryInputList // required
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * };
43
+ * const command = new BatchDeleteCategoryCommand(input);
44
+ * const response = await client.send(command);
45
+ * // {};
46
+ *
47
+ * ```
48
+ *
49
+ * @param BatchDeleteCategoryCommandInput - {@link BatchDeleteCategoryCommandInput}
50
+ * @returns {@link BatchDeleteCategoryCommandOutput}
51
+ * @see {@link BatchDeleteCategoryCommandInput} for command's `input` shape.
52
+ * @see {@link BatchDeleteCategoryCommandOutput} for command's `response` shape.
53
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
54
+ *
55
+ * @throws {@link AccessDeniedException} (client fault)
56
+ * <p>The client is not authorized to perform the requested operation.</p>
57
+ *
58
+ * @throws {@link ConflictException} (client fault)
59
+ * <p>The requested operation could not be completed due to a
60
+ * conflict with the current state of the resource.</p>
61
+ *
62
+ * @throws {@link InternalServerException} (server fault)
63
+ * <p>An internal service error occurred while processing the request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The requested resource could not be found.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>The requested operation could not be completed because too many
70
+ * requests were sent at once. Wait a bit and try again later.</p>
71
+ *
72
+ * @throws {@link UnauthorizedException} (client fault)
73
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
77
+ *
78
+ * @throws {@link QAppsServiceException}
79
+ * <p>Base exception class for all service exceptions from QApps service.</p>
80
+ *
81
+ * @public
82
+ * @example Deletes the categories in the library
83
+ * ```javascript
84
+ * //
85
+ * const input = {
86
+ * "categories": [
87
+ * "9c871ed4-1c41-4065-aefe-321cd4b61cf8"
88
+ * ],
89
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
90
+ * };
91
+ * const command = new BatchDeleteCategoryCommand(input);
92
+ * await client.send(command);
93
+ * // example id: example-1
94
+ * ```
95
+ *
96
+ */
97
+ export declare class BatchDeleteCategoryCommand extends BatchDeleteCategoryCommand_base {
98
+ /** @internal type navigation helper, not in runtime. */
99
+ protected static __types: {
100
+ api: {
101
+ input: BatchDeleteCategoryInput;
102
+ output: {};
103
+ };
104
+ sdk: {
105
+ input: BatchDeleteCategoryCommandInput;
106
+ output: BatchDeleteCategoryCommandOutput;
107
+ };
108
+ };
109
+ }
@@ -0,0 +1,120 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BatchUpdateCategoryInput } 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 BatchUpdateCategoryCommand}.
14
+ */
15
+ export interface BatchUpdateCategoryCommandInput extends BatchUpdateCategoryInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link BatchUpdateCategoryCommand}.
21
+ */
22
+ export interface BatchUpdateCategoryCommandOutput extends __MetadataBearer {
23
+ }
24
+ declare const BatchUpdateCategoryCommand_base: {
25
+ new (input: BatchUpdateCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchUpdateCategoryCommandInput, BatchUpdateCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: BatchUpdateCategoryCommandInput): import("@smithy/smithy-client").CommandImpl<BatchUpdateCategoryCommandInput, BatchUpdateCategoryCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, BatchUpdateCategoryCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, BatchUpdateCategoryCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // BatchUpdateCategoryInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * categories: [ // CategoryListInput // required
40
+ * { // CategoryInput
41
+ * id: "STRING_VALUE", // required
42
+ * title: "STRING_VALUE", // required
43
+ * color: "STRING_VALUE",
44
+ * },
45
+ * ],
46
+ * };
47
+ * const command = new BatchUpdateCategoryCommand(input);
48
+ * const response = await client.send(command);
49
+ * // {};
50
+ *
51
+ * ```
52
+ *
53
+ * @param BatchUpdateCategoryCommandInput - {@link BatchUpdateCategoryCommandInput}
54
+ * @returns {@link BatchUpdateCategoryCommandOutput}
55
+ * @see {@link BatchUpdateCategoryCommandInput} for command's `input` shape.
56
+ * @see {@link BatchUpdateCategoryCommandOutput} for command's `response` shape.
57
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>The client is not authorized to perform the requested operation.</p>
61
+ *
62
+ * @throws {@link ConflictException} (client fault)
63
+ * <p>The requested operation could not be completed due to a
64
+ * conflict with the current state of the resource.</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 ThrottlingException} (client fault)
73
+ * <p>The requested operation could not be completed because too many
74
+ * requests were sent at once. Wait a bit and try again later.</p>
75
+ *
76
+ * @throws {@link UnauthorizedException} (client fault)
77
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
81
+ *
82
+ * @throws {@link QAppsServiceException}
83
+ * <p>Base exception class for all service exceptions from QApps service.</p>
84
+ *
85
+ * @public
86
+ * @example Updates the categories in the library
87
+ * ```javascript
88
+ * //
89
+ * const input = {
90
+ * "categories": [
91
+ * {
92
+ * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
93
+ * "title": "HR Management"
94
+ * },
95
+ * {
96
+ * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
97
+ * "title": "Sales"
98
+ * }
99
+ * ],
100
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
101
+ * };
102
+ * const command = new BatchUpdateCategoryCommand(input);
103
+ * await client.send(command);
104
+ * // example id: example-1
105
+ * ```
106
+ *
107
+ */
108
+ export declare class BatchUpdateCategoryCommand extends BatchUpdateCategoryCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: BatchUpdateCategoryInput;
113
+ output: {};
114
+ };
115
+ sdk: {
116
+ input: BatchUpdateCategoryCommandInput;
117
+ output: BatchUpdateCategoryCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -50,6 +50,8 @@ declare const GetLibraryItemCommand_base: {
50
50
  * // { // Category
51
51
  * // id: "STRING_VALUE", // required
52
52
  * // title: "STRING_VALUE", // required
53
+ * // color: "STRING_VALUE",
54
+ * // appCount: Number("int"),
53
55
  * // },
54
56
  * // ],
55
57
  * // status: "STRING_VALUE", // required
@@ -101,11 +101,11 @@ declare const GetQAppSessionCommand_base: {
101
101
  * "cardStatus": {
102
102
  * "1e6caeac-b481-45ff-a082-8b9a4a0b72e8": {
103
103
  * "currentState": "COMPLETED",
104
- * "currentValue": "Earth's circumference is 24,901 miles"
104
+ * "currentValue": "Based on the responses, the most popular color is red, with 1 vote from the user \"user1\"."
105
105
  * },
106
106
  * "6fb5b404-3b7b-48a4-8a8b-56406922a606": {
107
107
  * "currentState": "COMPLETED",
108
- * "currentValue": "What is the circumference of Earth?"
108
+ * "currentValue": ""
109
109
  * }
110
110
  * },
111
111
  * "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/a929ecd6-5765-4ec7-bd3e-2ca90098b18e/qapp/65e7dce7-226a-47f9-b689-22850becef89/session/1fca878e-64c5-4dc4-b1d9-c93effed4e82",
@@ -0,0 +1,126 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListCategoriesInput, ListCategoriesOutput } 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 ListCategoriesCommand}.
14
+ */
15
+ export interface ListCategoriesCommandInput extends ListCategoriesInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListCategoriesCommand}.
21
+ */
22
+ export interface ListCategoriesCommandOutput extends ListCategoriesOutput, __MetadataBearer {
23
+ }
24
+ declare const ListCategoriesCommand_base: {
25
+ new (input: ListCategoriesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCategoriesCommandInput, ListCategoriesCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListCategoriesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCategoriesCommandInput, ListCategoriesCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists the categories of a Amazon Q Business application environment instance. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html">Custom labels for Amazon Q Apps</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { QAppsClient, ListCategoriesCommand } from "@aws-sdk/client-qapps"; // ES Modules import
35
+ * // const { QAppsClient, ListCategoriesCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
36
+ * const client = new QAppsClient(config);
37
+ * const input = { // ListCategoriesInput
38
+ * instanceId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new ListCategoriesCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListCategoriesOutput
43
+ * // categories: [ // CategoriesList
44
+ * // { // Category
45
+ * // id: "STRING_VALUE", // required
46
+ * // title: "STRING_VALUE", // required
47
+ * // color: "STRING_VALUE",
48
+ * // appCount: Number("int"),
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param ListCategoriesCommandInput - {@link ListCategoriesCommandInput}
56
+ * @returns {@link ListCategoriesCommandOutput}
57
+ * @see {@link ListCategoriesCommandInput} for command's `input` shape.
58
+ * @see {@link ListCategoriesCommandOutput} for command's `response` shape.
59
+ * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape.
60
+ *
61
+ * @throws {@link AccessDeniedException} (client fault)
62
+ * <p>The client is not authorized to perform the requested operation.</p>
63
+ *
64
+ * @throws {@link InternalServerException} (server fault)
65
+ * <p>An internal service error occurred while processing the request.</p>
66
+ *
67
+ * @throws {@link ResourceNotFoundException} (client fault)
68
+ * <p>The requested resource could not be found.</p>
69
+ *
70
+ * @throws {@link ThrottlingException} (client fault)
71
+ * <p>The requested operation could not be completed because too many
72
+ * requests were sent at once. Wait a bit and try again later.</p>
73
+ *
74
+ * @throws {@link UnauthorizedException} (client fault)
75
+ * <p>The client is not authenticated or authorized to perform the requested operation.</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>The input failed to satisfy the constraints specified by the service.</p>
79
+ *
80
+ * @throws {@link QAppsServiceException}
81
+ * <p>Base exception class for all service exceptions from QApps service.</p>
82
+ *
83
+ * @public
84
+ * @example List categories available for the library items in this instance
85
+ * ```javascript
86
+ * //
87
+ * const input = {
88
+ * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
89
+ * };
90
+ * const command = new ListCategoriesCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response ==
93
+ * {
94
+ * "categories": [
95
+ * {
96
+ * "appCount": 10,
97
+ * "color": "#FF6600",
98
+ * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
99
+ * "title": "HR"
100
+ * },
101
+ * {
102
+ * "appCount": 11,
103
+ * "color": "#FFFF00",
104
+ * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
105
+ * "title": "Marketing"
106
+ * }
107
+ * ]
108
+ * }
109
+ * *\/
110
+ * // example id: example-1
111
+ * ```
112
+ *
113
+ */
114
+ export declare class ListCategoriesCommand extends ListCategoriesCommand_base {
115
+ /** @internal type navigation helper, not in runtime. */
116
+ protected static __types: {
117
+ api: {
118
+ input: ListCategoriesInput;
119
+ output: ListCategoriesOutput;
120
+ };
121
+ sdk: {
122
+ input: ListCategoriesCommandInput;
123
+ output: ListCategoriesCommandOutput;
124
+ };
125
+ };
126
+ }
@@ -52,6 +52,8 @@ declare const ListLibraryItemsCommand_base: {
52
52
  * // { // Category
53
53
  * // id: "STRING_VALUE", // required
54
54
  * // title: "STRING_VALUE", // required
55
+ * // color: "STRING_VALUE",
56
+ * // appCount: Number("int"),
55
57
  * // },
56
58
  * // ],
57
59
  * // status: "STRING_VALUE", // required
@@ -52,6 +52,8 @@ declare const UpdateLibraryItemCommand_base: {
52
52
  * // { // Category
53
53
  * // id: "STRING_VALUE", // required
54
54
  * // title: "STRING_VALUE", // required
55
+ * // color: "STRING_VALUE",
56
+ * // appCount: Number("int"),
55
57
  * // },
56
58
  * // ],
57
59
  * // status: "STRING_VALUE", // required
@@ -1,5 +1,8 @@
1
1
  export * from "./AssociateLibraryItemReviewCommand";
2
2
  export * from "./AssociateQAppWithUserCommand";
3
+ export * from "./BatchCreateCategoryCommand";
4
+ export * from "./BatchDeleteCategoryCommand";
5
+ export * from "./BatchUpdateCategoryCommand";
3
6
  export * from "./CreateLibraryItemCommand";
4
7
  export * from "./CreateQAppCommand";
5
8
  export * from "./DeleteLibraryItemCommand";
@@ -10,6 +13,7 @@ export * from "./GetLibraryItemCommand";
10
13
  export * from "./GetQAppCommand";
11
14
  export * from "./GetQAppSessionCommand";
12
15
  export * from "./ImportDocumentCommand";
16
+ export * from "./ListCategoriesCommand";
13
17
  export * from "./ListLibraryItemsCommand";
14
18
  export * from "./ListQAppsCommand";
15
19
  export * from "./ListTagsForResourceCommand";