@aws-sdk/client-qapps 3.612.0

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

@@ -0,0 +1,95 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateQAppSessionInput, UpdateQAppSessionOutput } from "../models/models_0";
+import { QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QAppsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateQAppSessionCommand}.
+ */
+export interface UpdateQAppSessionCommandInput extends UpdateQAppSessionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateQAppSessionCommand}.
+ */
+export interface UpdateQAppSessionCommandOutput extends UpdateQAppSessionOutput, __MetadataBearer {
+}
+declare const UpdateQAppSessionCommand_base: {
+    new (input: UpdateQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionCommandInput, UpdateQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateQAppSessionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateQAppSessionCommandInput, UpdateQAppSessionCommandOutput, QAppsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the session for a given Q App <code>sessionId</code>. This is only
+ *       valid when at least one card of the session is in the <code>WAITING</code> state.
+ *       Data for each <code>WAITING</code> card can be provided as input. If inputs
+ *       are not provided, the call will be accepted but session will not move forward.
+ *       Inputs for cards that are not in the <code>WAITING</code> status will be ignored.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QAppsClient, UpdateQAppSessionCommand } from "@aws-sdk/client-qapps"; // ES Modules import
+ * // const { QAppsClient, UpdateQAppSessionCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
+ * const client = new QAppsClient(config);
+ * const input = { // UpdateQAppSessionInput
+ *   instanceId: "STRING_VALUE", // required
+ *   sessionId: "STRING_VALUE", // required
+ *   values: [ // CardValueList
+ *     { // CardValue
+ *       cardId: "STRING_VALUE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateQAppSessionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateQAppSessionOutput
+ * //   sessionId: "STRING_VALUE", // required
+ * //   sessionArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateQAppSessionCommandInput - {@link UpdateQAppSessionCommandInput}
+ * @returns {@link UpdateQAppSessionCommandOutput}
+ * @see {@link UpdateQAppSessionCommandInput} for command's `input` shape.
+ * @see {@link UpdateQAppSessionCommandOutput} 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 UpdateQAppSessionCommand extends UpdateQAppSessionCommand_base {
+}

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

@@ -0,0 +1,23 @@
+export * from "./AssociateLibraryItemReviewCommand";
+export * from "./AssociateQAppWithUserCommand";
+export * from "./CreateLibraryItemCommand";
+export * from "./CreateQAppCommand";
+export * from "./DeleteLibraryItemCommand";
+export * from "./DeleteQAppCommand";
+export * from "./DisassociateLibraryItemReviewCommand";
+export * from "./DisassociateQAppFromUserCommand";
+export * from "./GetLibraryItemCommand";
+export * from "./GetQAppCommand";
+export * from "./GetQAppSessionCommand";
+export * from "./ImportDocumentCommand";
+export * from "./ListLibraryItemsCommand";
+export * from "./ListQAppsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./PredictQAppCommand";
+export * from "./StartQAppSessionCommand";
+export * from "./StopQAppSessionCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateLibraryItemCommand";
+export * from "./UpdateQAppCommand";
+export * from "./UpdateQAppSessionCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,40 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface QAppsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
+ *       users to create lightweight, purpose-built AI apps to fulfill specific tasks from
+ *       within their web experience. For example, users can create an Q Appthat exclusively
+ *       generates marketing-related content to improve your marketing team's productivity or a
+ *       Q App for marketing content-generation like writing customer emails and creating
+ *       promotional content using a certain style of voice, tone, and branding.
+ *       For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/purpose-built-qapps.html">Amazon Q App</a> in the
+ *       <i>Amazon Q Business User Guide</i>.
+ *       </p>
+ *
+ * @packageDocumentation
+ */
+export * from "./QAppsClient";
+export * from "./QApps";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { QAppsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { QAppsServiceException } from "./models/QAppsServiceException";

package/dist-types/models/QAppsServiceException.d.ts

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from QApps service.
+ */
+export declare class QAppsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";