-
Notifications
You must be signed in to change notification settings - Fork 587
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-qapps): Introduces category apis in AmazonQApps. Web expe…
…rience users use Categories to tag and filter library items.
- Loading branch information
awstools
committed
Nov 6, 2024
1 parent
6860b35
commit 9e3e6fb
Showing
15 changed files
with
1,518 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
141 changes: 141 additions & 0 deletions
141
clients/client-qapps/src/commands/BatchCreateCategoryCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { BatchCreateCategoryInput } from "../models/models_0"; | ||
| import { de_BatchCreateCategoryCommand, se_BatchCreateCategoryCommand } from "../protocols/Aws_restJson1"; | ||
| import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link BatchCreateCategoryCommand}. | ||
| */ | ||
| export interface BatchCreateCategoryCommandInput extends BatchCreateCategoryInput {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link BatchCreateCategoryCommand}. | ||
| */ | ||
| export interface BatchCreateCategoryCommandOutput extends __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <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> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { QAppsClient, BatchCreateCategoryCommand } from "@aws-sdk/client-qapps"; // ES Modules import | ||
| * // const { QAppsClient, BatchCreateCategoryCommand } = require("@aws-sdk/client-qapps"); // CommonJS import | ||
| * const client = new QAppsClient(config); | ||
| * const input = { // BatchCreateCategoryInput | ||
| * instanceId: "STRING_VALUE", // required | ||
| * categories: [ // BatchCreateCategoryInputCategoryList // required | ||
| * { // BatchCreateCategoryInputCategory | ||
| * id: "STRING_VALUE", | ||
| * title: "STRING_VALUE", // required | ||
| * color: "STRING_VALUE", | ||
| * }, | ||
| * ], | ||
| * }; | ||
| * const command = new BatchCreateCategoryCommand(input); | ||
| * const response = await client.send(command); | ||
| * // {}; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param BatchCreateCategoryCommandInput - {@link BatchCreateCategoryCommandInput} | ||
| * @returns {@link BatchCreateCategoryCommandOutput} | ||
| * @see {@link BatchCreateCategoryCommandInput} for command's `input` shape. | ||
| * @see {@link BatchCreateCategoryCommandOutput} for command's `response` shape. | ||
| * @see {@link QAppsClientResolvedConfig | config} for QAppsClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>The client is not authorized to perform the requested operation.</p> | ||
| * | ||
| * @throws {@link ConflictException} (client fault) | ||
| * <p>The requested operation could not be completed due to a | ||
| * conflict with the current state of the resource.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * <p>An internal service error occurred while processing the request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * <p>The requested resource could not be found.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * <p>The requested operation could not be completed because too many | ||
| * requests were sent at once. Wait a bit and try again later.</p> | ||
| * | ||
| * @throws {@link UnauthorizedException} (client fault) | ||
| * <p>The client is not authenticated or authorized to perform the requested operation.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * <p>The input failed to satisfy the constraints specified by the service.</p> | ||
| * | ||
| * @throws {@link QAppsServiceException} | ||
| * <p>Base exception class for all service exceptions from QApps service.</p> | ||
| * | ||
| * @public | ||
| * @example Creates the categories for the library | ||
| * ```javascript | ||
| * // | ||
| * const input = { | ||
| * "categories": [ | ||
| * { | ||
| * "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d", | ||
| * "title": "HR" | ||
| * }, | ||
| * { | ||
| * "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f", | ||
| * "title": "Marketing" | ||
| * } | ||
| * ], | ||
| * "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f" | ||
| * }; | ||
| * const command = new BatchCreateCategoryCommand(input); | ||
| * await client.send(command); | ||
| * // example id: example-1 | ||
| * ``` | ||
| * | ||
| */ | ||
| export class BatchCreateCategoryCommand extends $Command | ||
| .classBuilder< | ||
| BatchCreateCategoryCommandInput, | ||
| BatchCreateCategoryCommandOutput, | ||
| QAppsClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep(commonParams) | ||
| .m(function (this: any, Command: any, cs: any, config: QAppsClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("QAppsService", "BatchCreateCategory", {}) | ||
| .n("QAppsClient", "BatchCreateCategoryCommand") | ||
| .f(void 0, void 0) | ||
| .ser(se_BatchCreateCategoryCommand) | ||
| .de(de_BatchCreateCategoryCommand) | ||
| .build() { | ||
| /** @internal type navigation helper, not in runtime. */ | ||
| protected declare static __types: { | ||
| api: { | ||
| input: BatchCreateCategoryInput; | ||
| output: {}; | ||
| }; | ||
| sdk: { | ||
| input: BatchCreateCategoryCommandInput; | ||
| output: BatchCreateCategoryCommandOutput; | ||
| }; | ||
| }; | ||
| } |
Oops, something went wrong.