@aws-sdk/client-qapps 3.774.0 → 3.777.0

package/dist-types/commands/DescribeQAppPermissionsCommand.d.ts

@@ -85,41 +85,41 @@ declare const DescribeQAppPermissionsCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Describe permissions for the app
  * ```javascript
  * //
  * const input = {
- *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
- *   "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
+ *   appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   instanceId: "01793661-ad73-4c7d-8eaa-1c95a10151c2"
  * };
  * const command = new DescribeQAppPermissionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
- *   "permissions": [
+ *   appId: "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   permissions: [
  *     {
- *       "action": "write",
- *       "principal": {
- *         "email": "user1@example.com",
- *         "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
+ *       action: "write",
+ *       principal: {
+ *         email: "user1@example.com",
+ *         userId: "f8f15330-b091-708b-d46e-adb0d914b699"
  *       }
  *     },
  *     {
- *       "action": "read",
- *       "principal": {
- *         "email": "user2@example.com",
- *         "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
+ *       action: "read",
+ *       principal: {
+ *         email: "user2@example.com",
+ *         userId: "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
  *       }
  *     }
  *   ],
- *   "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
+ *   resourceArn: "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class DescribeQAppPermissionsCommand extends DescribeQAppPermissionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DisassociateLibraryItemReviewCommand.d.ts

@@ -80,19 +80,22 @@ declare const DisassociateLibraryItemReviewCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Decrease the rating counter by 1 for the related app for this user
  * ```javascript
  * //
  * const input = {
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "libraryItemId": "cb9ecf72-8563-450d-9db9-994f98297316"
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   libraryItemId: "cb9ecf72-8563-450d-9db9-994f98297316"
  * };
  * const command = new DisassociateLibraryItemReviewCommand(input);
- * await client.send(command);
- * // example id: example-1
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DisassociateLibraryItemReviewCommand extends DisassociateLibraryItemReviewCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DisassociateQAppFromUserCommand.d.ts

@@ -72,19 +72,22 @@ declare const DisassociateQAppFromUserCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Unlinks an Amazon Q App from the invoker's list of apps
  * ```javascript
  * //
  * const input = {
- *   "appId": "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
+ *   appId: "393e77fb-0a30-4f47-ad30-75d71aeaed8a",
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
  * };
  * const command = new DisassociateQAppFromUserCommand(input);
- * await client.send(command);
- * // example id: example-1
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DisassociateQAppFromUserCommand extends DisassociateQAppFromUserCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ExportQAppSessionDataCommand.d.ts

@@ -84,6 +84,7 @@ declare const ExportQAppSessionDataCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
+ *
  * @public
  */
 export declare class ExportQAppSessionDataCommand extends ExportQAppSessionDataCommand_base {

package/dist-types/commands/GetLibraryItemCommand.d.ts

@@ -95,49 +95,49 @@ declare const GetLibraryItemCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Retrieve a library item
  * ```javascript
  * //
  * const input = {
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "libraryItemId": "18cbebaa-196a-4aa5-a840-88d548e07f8f"
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   libraryItemId: "18cbebaa-196a-4aa5-a840-88d548e07f8f"
  * };
  * const command = new GetLibraryItemCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "appId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "appVersion": 1,
- *   "categories": [
+ *   appId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   appVersion: 1,
+ *   categories: [
  *     {
- *       "id": "9c871ed4-1c41-4065-aefe-321cd4b61cf8",
- *       "title": "HR"
+ *       id: "9c871ed4-1c41-4065-aefe-321cd4b61cf8",
+ *       title: "HR"
  *     },
  *     {
- *       "id": "fdc4b483-c4e2-44c9-b4b2-6c850bbdb579",
- *       "title": "General"
+ *       id: "fdc4b483-c4e2-44c9-b4b2-6c850bbdb579",
+ *       title: "General"
  *     },
  *     {
- *       "id": "c1c4e374-118c-446f-81fb-cba6225d88da",
- *       "title": "IT"
+ *       id: "c1c4e374-118c-446f-81fb-cba6225d88da",
+ *       title: "IT"
  *     }
  *   ],
- *   "createdAt": "2024-05-08T16:09:56.080Z",
- *   "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
- *   "isRatedByUser": false,
- *   "isVerified": false,
- *   "libraryItemId": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
- *   "ratingCount": 0,
- *   "status": "PUBLISHED",
- *   "updatedAt": "2024-05-08T16:09:56.080Z",
- *   "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
- *   "userCount": 1
+ *   createdAt: "2024-05-08T16:09:56.080Z",
+ *   createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
+ *   isRatedByUser: false,
+ *   isVerified: false,
+ *   libraryItemId: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
+ *   ratingCount: 0,
+ *   status: "PUBLISHED",
+ *   updatedAt: "2024-05-08T16:09:56.080Z",
+ *   updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
+ *   userCount: 1
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetLibraryItemCommand extends GetLibraryItemCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetQAppCommand.d.ts

@@ -236,57 +236,57 @@ declare const GetQAppCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example A basic application with 1 text input card and 1 output card
  * ```javascript
  * //
  * const input = {
- *   "appId": "3d110749-efc3-427c-87e8-15e966e5c168",
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
+ *   appId: "3d110749-efc3-427c-87e8-15e966e5c168",
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
  * };
  * const command = new GetQAppCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "appArn": "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
- *   "appDefinition": {
- *     "appDefinitionVersion": "1",
- *     "cards": [
+ *   appArn: "arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0",
+ *   appDefinition: {
+ *     appDefinitionVersion: "1",
+ *     cards: [
  *       {
- *         "textInput": {
- *           "type": "text-input",
- *           "dependencies": [],
- *           "id": "4cf94d96-8819-45c2-98cc-58c56b35c72f",
- *           "title": "Color Base"
+ *         textInput: {
+ *           dependencies:           [],
+ *           id: "4cf94d96-8819-45c2-98cc-58c56b35c72f",
+ *           title: "Color Base",
+ *           type: "text-input"
  *         }
  *       },
  *       {
- *         "qQuery": {
- *           "type": "q-query",
- *           "dependencies": [
+ *         qQuery: {
+ *           dependencies: [
  *             "91e4513d-6981-454a-9329-329c9302eef4"
  *           ],
- *           "id": "18870b94-1e63-40e0-8c12-669c90ac5acc",
- *           "outputSource": "llm",
- *           "prompt": "Recommend me a list of colors that go well with @91e4513d-6981-454a-9329-329c9302eef4 ",
- *           "title": "Recommended Palette"
+ *           id: "18870b94-1e63-40e0-8c12-669c90ac5acc",
+ *           outputSource: "llm",
+ *           prompt: "Recommend me a list of colors that go well with @91e4513d-6981-454a-9329-329c9302eef4 ",
+ *           title: "Recommended Palette",
+ *           type: "q-query"
  *         }
  *       }
  *     ]
  *   },
- *   "appId": "7212ff04-de7b-4831-bd80-45d6975ba1b0",
- *   "appVersion": 1,
- *   "createdAt": "2024-05-14T00:11:54.232Z",
- *   "createdBy": "a841e300-40c1-7062-fa34-5b46dadbbaac",
- *   "status": "DRAFT",
- *   "title": "Color Palette Generator",
- *   "updatedAt": "2024-05-14T00:13:26.168Z",
- *   "updatedBy": "a841e300-40c1-7062-fa34-5b46dadbbaac"
+ *   appId: "7212ff04-de7b-4831-bd80-45d6975ba1b0",
+ *   appVersion: 1,
+ *   createdAt: "2024-05-14T00:11:54.232Z",
+ *   createdBy: "a841e300-40c1-7062-fa34-5b46dadbbaac",
+ *   status: "DRAFT",
+ *   title: "Color Palette Generator",
+ *   updatedAt: "2024-05-14T00:13:26.168Z",
+ *   updatedBy: "a841e300-40c1-7062-fa34-5b46dadbbaac"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetQAppCommand extends GetQAppCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetQAppSessionCommand.d.ts

@@ -97,46 +97,46 @@ declare const GetQAppSessionCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Retrieves an existing session for an Amazon Q App
  * ```javascript
  * //
  * const input = {
- *   "instanceId": "288ae830-1df2-4871-b6c0-4314d74dadef",
- *   "sessionId": "1fca878e-64c5-4dc4-b1d9-c93effed4e82"
+ *   instanceId: "288ae830-1df2-4871-b6c0-4314d74dadef",
+ *   sessionId: "1fca878e-64c5-4dc4-b1d9-c93effed4e82"
  * };
  * const command = new GetQAppSessionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "cardStatus": {
- *     "1e6caeac-b481-45ff-a082-8b9a4a0b72e8": {
- *       "currentState": "COMPLETED",
- *       "currentValue": "Based on the responses, the most popular color is red, with 1 vote from the user \"user1\"."
+ *   cardStatus: {
+ *     1e6caeac-b481-45ff-a082-8b9a4a0b72e8: {
+ *       currentState: "COMPLETED",
+ *       currentValue: `Based on the responses, the most popular color is red, with 1 vote from the user "user1".`
  *     },
- *     "6fb5b404-3b7b-48a4-8a8b-56406922a606": {
- *       "currentState": "COMPLETED",
- *       "currentValue": "",
- *       "submissions": [
+ *     6fb5b404-3b7b-48a4-8a8b-56406922a606: {
+ *       currentState: "COMPLETED",
+ *       currentValue: "",
+ *       submissions: [
  *         {
- *           "value": {
- *             "18cee4cb-253e-4f87-9154-849fbb98e482": "user1",
- *             "d52030f9-6c4b-47a9-a946-377f632c77cc": "red"
- *           },
- *           "submissionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
- *           "timestamp": "2023-06-15T14:30:45Z"
+ *           submissionId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+ *           timestamp: "2023-06-15T14:30:45Z",
+ *           value: {
+ *             18cee4cb-253e-4f87-9154-849fbb98e482: "user1",
+ *             d52030f9-6c4b-47a9-a946-377f632c77cc: "red"
+ *           }
  *         }
  *       ]
  *     }
  *   },
- *   "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",
- *   "sessionId": "1fca878e-64c5-4dc4-b1d9-c93effed4e82",
- *   "status": "COMPLETED"
+ *   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",
+ *   sessionId: "1fca878e-64c5-4dc4-b1d9-c93effed4e82",
+ *   status: "COMPLETED"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetQAppSessionCommand extends GetQAppSessionCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetQAppSessionMetadataCommand.d.ts

@@ -86,32 +86,32 @@ declare const GetQAppSessionMetadataCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Retrieves an existing session metadata for an Amazon Q App
  * ```javascript
  * //
  * const input = {
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb"
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   sessionId: "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb"
  * };
  * const command = new GetQAppSessionMetadataCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "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",
- *   "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
- *   "sessionName": "Trip itinerary collection session",
- *   "sessionOwner": true,
- *   "sharingConfiguration": {
- *     "acceptResponses": true,
- *     "enabled": true,
- *     "revealCards": false
+ *   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",
+ *   sessionId: "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
+ *   sessionName: "Trip itinerary collection session",
+ *   sessionOwner: true,
+ *   sharingConfiguration: {
+ *     acceptResponses: true,
+ *     enabled: true,
+ *     revealCards: false
  *   }
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetQAppSessionMetadataCommand extends GetQAppSessionMetadataCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ImportDocumentCommand.d.ts

@@ -90,50 +90,49 @@ declare const ImportDocumentCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example Upload a file to a specific session
  * ```javascript
  * //
  * const input = {
- *   "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
- *   "cardId": "82f69028-22a9-4bea-8727-0eabf58e9fed",
- *   "fileContentsBase64": "data:text/plain;base64,SomeFileEncodedInBase64",
- *   "fileName": "myFile.txt",
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "scope": "SESSION",
- *   "sessionId": "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
+ *   appId: "4263767c-d889-4cb2-a8f6-8b649bc66af0",
+ *   cardId: "82f69028-22a9-4bea-8727-0eabf58e9fed",
+ *   fileContentsBase64: "data:text/plain;base64,SomeFileEncodedInBase64",
+ *   fileName: "myFile.txt",
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   scope: "SESSION",
+ *   sessionId: "4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"
  * };
  * const command = new ImportDocumentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "fileId": "412aa1b4-341c-45af-936d-da52f8a1a3b4"
+ *   fileId: "412aa1b4-341c-45af-936d-da52f8a1a3b4"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
  * @example Upload a file into a application
  * ```javascript
  * //
  * const input = {
- *   "appId": "4263767c-d889-4cb2-a8f6-8b649bc66af0",
- *   "cardId": "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
- *   "fileContentsBase64": "data:text/plain;base64,SomeFileEncodedInBase64",
- *   "fileName": "anApplicationFile.txt",
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
- *   "scope": "APPLICATION"
+ *   appId: "4263767c-d889-4cb2-a8f6-8b649bc66af0",
+ *   cardId: "7a11f34b-42d4-4bc8-b668-ae4a788dae1e",
+ *   fileContentsBase64: "data:text/plain;base64,SomeFileEncodedInBase64",
+ *   fileName: "anApplicationFile.txt",
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   scope: "APPLICATION"
  * };
  * const command = new ImportDocumentCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "fileId": "bc1a0cc9-076a-4e82-9a6c-f4d2d8a22489"
+ *   fileId: "bc1a0cc9-076a-4e82-9a6c-f4d2d8a22489"
  * }
  * *\/
- * // example id: example-2
  * ```
  *
+ * @public
  */
 export declare class ImportDocumentCommand extends ImportDocumentCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/ListCategoriesCommand.d.ts

@@ -81,36 +81,36 @@ declare const ListCategoriesCommand_base: {
  * @throws {@link QAppsServiceException}
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
- * @public
+ *
  * @example List categories available for the library items in this instance
  * ```javascript
  * //
  * const input = {
- *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
+ *   instanceId: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"
  * };
  * const command = new ListCategoriesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "categories": [
+ *   categories: [
  *     {
- *       "appCount": 10,
- *       "color": "#FF6600",
- *       "id": "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
- *       "title": "HR"
+ *       appCount: 10,
+ *       color: "#FF6600",
+ *       id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
+ *       title: "HR"
  *     },
  *     {
- *       "appCount": 11,
- *       "color": "#FFFF00",
- *       "id": "18cbebaa-196a-4aa5-a840-88d548e07f8f",
- *       "title": "Marketing"
+ *       appCount: 11,
+ *       color: "#FFFF00",
+ *       id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
+ *       title: "Marketing"
  *     }
  *   ]
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class ListCategoriesCommand extends ListCategoriesCommand_base {
     /** @internal type navigation helper, not in runtime. */