@aws-sdk/client-qapps 3.699.0 → 3.701.0

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

@@ -0,0 +1,108 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListQAppSessionDataInput, ListQAppSessionDataOutput } from "../models/models_0";
+import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListQAppSessionDataCommand}.
+ */
+export interface ListQAppSessionDataCommandInput extends ListQAppSessionDataInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListQAppSessionDataCommand}.
+ */
+export interface ListQAppSessionDataCommandOutput extends ListQAppSessionDataOutput, __MetadataBearer {
+}
+declare const ListQAppSessionDataCommand_base: {
+    new (input: ListQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ListQAppSessionDataCommandInput, ListQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListQAppSessionDataCommandInput): import("@smithy/smithy-client").CommandImpl<ListQAppSessionDataCommandInput, ListQAppSessionDataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the collected data of a Q App data collection session.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QAppsClient, ListQAppSessionDataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
+ * // const { QAppsClient, ListQAppSessionDataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
+ * const client = new QAppsClient(config);
+ * const input = { // ListQAppSessionDataInput
+ *   instanceId: "STRING_VALUE", // required
+ *   sessionId: "STRING_VALUE", // required
+ * };
+ * const command = new ListQAppSessionDataCommand(input);
+ * const response = await client.send(command);
+ * // { // ListQAppSessionDataOutput
+ * //   sessionId: "STRING_VALUE", // required
+ * //   sessionArn: "STRING_VALUE", // required
+ * //   sessionData: [ // QAppSessionDataList
+ * //     { // QAppSessionData
+ * //       cardId: "STRING_VALUE", // required
+ * //       value: "DOCUMENT_VALUE",
+ * //       user: { // User
+ * //         userId: "STRING_VALUE",
+ * //       },
+ * //       submissionId: "STRING_VALUE",
+ * //       timestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListQAppSessionDataCommandInput - {@link ListQAppSessionDataCommandInput}
+ * @returns {@link ListQAppSessionDataCommandOutput}
+ * @see {@link ListQAppSessionDataCommandInput} for command's `input` shape.
+ * @see {@link ListQAppSessionDataCommandOutput} 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 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 ServiceQuotaExceededException} (client fault)
+ *  <p>The requested operation could not be completed because
+ *       it would exceed the service's quota or limit.</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
+ */
+export declare class ListQAppSessionDataCommand extends ListQAppSessionDataCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListQAppSessionDataInput;
+            output: ListQAppSessionDataOutput;
+        };
+        sdk: {
+            input: ListQAppSessionDataCommandInput;
+            output: ListQAppSessionDataCommandOutput;
+        };
+    };
+}

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

@@ -61,14 +61,14 @@ declare const PredictQAppCommand_base: {
  * //           textInput: { // TextInputCardInput
  * //             title: "STRING_VALUE", // required
  * //             id: "STRING_VALUE", // required
- * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  * //             placeholder: "STRING_VALUE",
  * //             defaultValue: "STRING_VALUE",
  * //           },
  * //           qQuery: { // QQueryCardInput
  * //             title: "STRING_VALUE", // required
  * //             id: "STRING_VALUE", // required
- * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  * //             prompt: "STRING_VALUE", // required
  * //             outputSource: "approved-sources" || "llm",
  * //             attributeFilter: { // AttributeFilter
@@ -156,18 +156,27 @@ declare const PredictQAppCommand_base: {
  * //           qPlugin: { // QPluginCardInput
  * //             title: "STRING_VALUE", // required
  * //             id: "STRING_VALUE", // required
- * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  * //             prompt: "STRING_VALUE", // required
  * //             pluginId: "STRING_VALUE", // required
  * //           },
  * //           fileUpload: { // FileUploadCardInput
  * //             title: "STRING_VALUE", // required
  * //             id: "STRING_VALUE", // required
- * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  * //             filename: "STRING_VALUE",
  * //             fileId: "STRING_VALUE",
  * //             allowOverride: true || false,
  * //           },
+ * //           formInput: { // FormInputCardInput
+ * //             title: "STRING_VALUE", // required
+ * //             id: "STRING_VALUE", // required
+ * //             type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
+ * //             metadata: { // FormInputCardMetadata
+ * //               schema: "DOCUMENT_VALUE", // required
+ * //             },
+ * //             computeMode: "append" || "replace",
+ * //           },
  * //         },
  * //       ],
  * //       initialPrompt: "STRING_VALUE",

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

@@ -47,8 +47,13 @@ declare const StartQAppSessionCommand_base: {
  *     { // CardValue
  *       cardId: "STRING_VALUE", // required
  *       value: "STRING_VALUE", // required
+ *       submissionMutation: { // SubmissionMutation
+ *         submissionId: "STRING_VALUE", // required
+ *         mutationType: "edit" || "delete" || "add", // required
+ *       },
  *     },
  *   ],
+ *   sessionId: "STRING_VALUE",
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },

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

@@ -45,14 +45,14 @@ declare const UpdateQAppCommand_base: {
  *         textInput: { // TextInputCardInput
  *           title: "STRING_VALUE", // required
  *           id: "STRING_VALUE", // required
- *           type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ *           type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  *           placeholder: "STRING_VALUE",
  *           defaultValue: "STRING_VALUE",
  *         },
  *         qQuery: { // QQueryCardInput
  *           title: "STRING_VALUE", // required
  *           id: "STRING_VALUE", // required
- *           type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ *           type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  *           prompt: "STRING_VALUE", // required
  *           outputSource: "approved-sources" || "llm",
  *           attributeFilter: { // AttributeFilter
@@ -140,18 +140,27 @@ declare const UpdateQAppCommand_base: {
  *         qPlugin: { // QPluginCardInput
  *           title: "STRING_VALUE", // required
  *           id: "STRING_VALUE", // required
- *           type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ *           type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  *           prompt: "STRING_VALUE", // required
  *           pluginId: "STRING_VALUE", // required
  *         },
  *         fileUpload: { // FileUploadCardInput
  *           title: "STRING_VALUE", // required
  *           id: "STRING_VALUE", // required
- *           type: "text-input" || "q-query" || "file-upload" || "q-plugin", // required
+ *           type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
  *           filename: "STRING_VALUE",
  *           fileId: "STRING_VALUE",
  *           allowOverride: true || false,
  *         },
+ *         formInput: { // FormInputCardInput
+ *           title: "STRING_VALUE", // required
+ *           id: "STRING_VALUE", // required
+ *           type: "text-input" || "q-query" || "file-upload" || "q-plugin" || "form-input", // required
+ *           metadata: { // FormInputCardMetadata
+ *             schema: "DOCUMENT_VALUE", // required
+ *           },
+ *           computeMode: "append" || "replace",
+ *         },
  *       },
  *     ],
  *     initialPrompt: "STRING_VALUE",

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

@@ -0,0 +1,114 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateQAppPermissionsInput, UpdateQAppPermissionsOutput } from "../models/models_0";
+import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateQAppPermissionsCommand}.
+ */
+export interface UpdateQAppPermissionsCommandInput extends UpdateQAppPermissionsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateQAppPermissionsCommand}.
+ */
+export interface UpdateQAppPermissionsCommandOutput extends UpdateQAppPermissionsOutput, __MetadataBearer {
+}
+declare const UpdateQAppPermissionsCommand_base: {
+    new (input: UpdateQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppPermissionsCommandInput, UpdateQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateQAppPermissionsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppPermissionsCommandInput, UpdateQAppPermissionsCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QAppsClient, UpdateQAppPermissionsCommand } from "@aws-sdk/client-qapps"; // ES Modules import
+ * // const { QAppsClient, UpdateQAppPermissionsCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
+ * const client = new QAppsClient(config);
+ * const input = { // UpdateQAppPermissionsInput
+ *   instanceId: "STRING_VALUE", // required
+ *   appId: "STRING_VALUE", // required
+ *   grantPermissions: [ // PermissionsInputList
+ *     { // PermissionInput
+ *       action: "read" || "write", // required
+ *       principal: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   revokePermissions: [
+ *     {
+ *       action: "read" || "write", // required
+ *       principal: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateQAppPermissionsCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateQAppPermissionsOutput
+ * //   resourceArn: "STRING_VALUE",
+ * //   appId: "STRING_VALUE",
+ * //   permissions: [ // PermissionsOutputList
+ * //     { // PermissionOutput
+ * //       action: "read" || "write", // required
+ * //       principal: { // PrincipalOutput
+ * //         userId: "STRING_VALUE",
+ * //         userType: "owner" || "user",
+ * //         email: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateQAppPermissionsCommandInput - {@link UpdateQAppPermissionsCommandInput}
+ * @returns {@link UpdateQAppPermissionsCommandOutput}
+ * @see {@link UpdateQAppPermissionsCommandInput} for command's `input` shape.
+ * @see {@link UpdateQAppPermissionsCommandOutput} 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 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
+ */
+export declare class UpdateQAppPermissionsCommand extends UpdateQAppPermissionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateQAppPermissionsInput;
+            output: UpdateQAppPermissionsOutput;
+        };
+        sdk: {
+            input: UpdateQAppPermissionsCommandInput;
+            output: UpdateQAppPermissionsCommandOutput;
+        };
+    };
+}

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

@@ -45,6 +45,10 @@ declare const UpdateQAppSessionCommand_base: {
  *     { // CardValue
  *       cardId: "STRING_VALUE", // required
  *       value: "STRING_VALUE", // required
+ *       submissionMutation: { // SubmissionMutation
+ *         submissionId: "STRING_VALUE", // required
+ *         mutationType: "edit" || "delete" || "add", // required
+ *       },
  *     },
  *   ],
  * };

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

@@ -0,0 +1,108 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateQAppSessionMetadataInput, UpdateQAppSessionMetadataOutput } from "../models/models_0";
+import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateQAppSessionMetadataCommand}.
+ */
+export interface UpdateQAppSessionMetadataCommandInput extends UpdateQAppSessionMetadataInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateQAppSessionMetadataCommand}.
+ */
+export interface UpdateQAppSessionMetadataCommandOutput extends UpdateQAppSessionMetadataOutput, __MetadataBearer {
+}
+declare const UpdateQAppSessionMetadataCommand_base: {
+    new (input: UpdateQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionMetadataCommandInput, UpdateQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateQAppSessionMetadataCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionMetadataCommandInput, UpdateQAppSessionMetadataCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the configuration metadata of a session for a given Q App <code>sessionId</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QAppsClient, UpdateQAppSessionMetadataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
+ * // const { QAppsClient, UpdateQAppSessionMetadataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
+ * const client = new QAppsClient(config);
+ * const input = { // UpdateQAppSessionMetadataInput
+ *   instanceId: "STRING_VALUE", // required
+ *   sessionId: "STRING_VALUE", // required
+ *   sessionName: "STRING_VALUE",
+ *   sharingConfiguration: { // SessionSharingConfiguration
+ *     enabled: true || false, // required
+ *     acceptResponses: true || false,
+ *     revealCards: true || false,
+ *   },
+ * };
+ * const command = new UpdateQAppSessionMetadataCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateQAppSessionMetadataOutput
+ * //   sessionId: "STRING_VALUE", // required
+ * //   sessionArn: "STRING_VALUE", // required
+ * //   sessionName: "STRING_VALUE",
+ * //   sharingConfiguration: { // SessionSharingConfiguration
+ * //     enabled: true || false, // required
+ * //     acceptResponses: true || false,
+ * //     revealCards: true || false,
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateQAppSessionMetadataCommandInput - {@link UpdateQAppSessionMetadataCommandInput}
+ * @returns {@link UpdateQAppSessionMetadataCommandOutput}
+ * @see {@link UpdateQAppSessionMetadataCommandInput} for command's `input` shape.
+ * @see {@link UpdateQAppSessionMetadataCommandOutput} 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 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 ServiceQuotaExceededException} (client fault)
+ *  <p>The requested operation could not be completed because
+ *       it would exceed the service's quota or limit.</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
+ */
+export declare class UpdateQAppSessionMetadataCommand extends UpdateQAppSessionMetadataCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateQAppSessionMetadataInput;
+            output: UpdateQAppSessionMetadataOutput;
+        };
+        sdk: {
+            input: UpdateQAppSessionMetadataCommandInput;
+            output: UpdateQAppSessionMetadataCommandOutput;
+        };
+    };
+}

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

@@ -4,17 +4,22 @@ export * from "./BatchCreateCategoryCommand";
 export * from "./BatchDeleteCategoryCommand";
 export * from "./BatchUpdateCategoryCommand";
 export * from "./CreateLibraryItemCommand";
+export * from "./CreatePresignedUrlCommand";
 export * from "./CreateQAppCommand";
 export * from "./DeleteLibraryItemCommand";
 export * from "./DeleteQAppCommand";
+export * from "./DescribeQAppPermissionsCommand";
 export * from "./DisassociateLibraryItemReviewCommand";
 export * from "./DisassociateQAppFromUserCommand";
+export * from "./ExportQAppSessionDataCommand";
 export * from "./GetLibraryItemCommand";
 export * from "./GetQAppCommand";
 export * from "./GetQAppSessionCommand";
+export * from "./GetQAppSessionMetadataCommand";
 export * from "./ImportDocumentCommand";
 export * from "./ListCategoriesCommand";
 export * from "./ListLibraryItemsCommand";
+export * from "./ListQAppSessionDataCommand";
 export * from "./ListQAppsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PredictQAppCommand";
@@ -25,4 +30,6 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateLibraryItemCommand";
 export * from "./UpdateLibraryItemMetadataCommand";
 export * from "./UpdateQAppCommand";
+export * from "./UpdateQAppPermissionsCommand";
 export * from "./UpdateQAppSessionCommand";
+export * from "./UpdateQAppSessionMetadataCommand";