@aws-amplify/graphql-api-construct 1.20.0 → 1.20.2

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/commands/InvokeModelWithResponseStreamCommand.d.ts

@@ -0,0 +1,139 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { BlobPayloadInputTypes, MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import { InvokeModelWithResponseStreamRequest, InvokeModelWithResponseStreamResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ */
+export type InvokeModelWithResponseStreamCommandInputType = Omit<InvokeModelWithResponseStreamRequest, "body"> & {
+    body: BlobPayloadInputTypes;
+};
+/**
+ * @public
+ *
+ * The input for {@link InvokeModelWithResponseStreamCommand}.
+ */
+export interface InvokeModelWithResponseStreamCommandInput extends InvokeModelWithResponseStreamCommandInputType {
+}
+/**
+ * @public
+ *
+ * The output of {@link InvokeModelWithResponseStreamCommand}.
+ */
+export interface InvokeModelWithResponseStreamCommandOutput extends InvokeModelWithResponseStreamResponse, __MetadataBearer {
+}
+declare const InvokeModelWithResponseStreamCommand_base: {
+    new (input: InvokeModelWithResponseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeModelWithResponseStreamCommandInput, InvokeModelWithResponseStreamCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: InvokeModelWithResponseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<InvokeModelWithResponseStreamCommandInput, InvokeModelWithResponseStreamCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.</p>
+ *          <p>To see if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
+ *          and check the <code>responseStreamingSupported</code> field in the response.</p>
+ *          <note>
+ *             <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p>
+ *          </note>
+ *          <p>For example code, see <i>Invoke model with streaming code
+ *          example</i> in the <i>Amazon Bedrock User Guide</i>.
+ *       </p>
+ *          <p>This operation requires permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, InvokeModelWithResponseStreamCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, InvokeModelWithResponseStreamCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // InvokeModelWithResponseStreamRequest
+ *   body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   contentType: "STRING_VALUE",
+ *   accept: "STRING_VALUE",
+ *   modelId: "STRING_VALUE", // required
+ *   trace: "ENABLED" || "DISABLED",
+ *   guardrailIdentifier: "STRING_VALUE",
+ *   guardrailVersion: "STRING_VALUE",
+ * };
+ * const command = new InvokeModelWithResponseStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // InvokeModelWithResponseStreamResponse
+ * //   body: { // ResponseStream Union: only one key present
+ * //     chunk: { // PayloadPart
+ * //       bytes: new Uint8Array(),
+ * //     },
+ * //     internalServerException: { // InternalServerException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     modelStreamErrorException: { // ModelStreamErrorException
+ * //       message: "STRING_VALUE",
+ * //       originalStatusCode: Number("int"),
+ * //       originalMessage: "STRING_VALUE",
+ * //     },
+ * //     validationException: { // ValidationException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     throttlingException: { // ThrottlingException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     modelTimeoutException: { // ModelTimeoutException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     serviceUnavailableException: { // ServiceUnavailableException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   contentType: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param InvokeModelWithResponseStreamCommandInput - {@link InvokeModelWithResponseStreamCommandInput}
+ * @returns {@link InvokeModelWithResponseStreamCommandOutput}
+ * @see {@link InvokeModelWithResponseStreamCommandInput} for command's `input` shape.
+ * @see {@link InvokeModelWithResponseStreamCommandOutput} for command's `response` shape.
+ * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ModelErrorException} (client fault)
+ *  <p>The request failed due to an error while processing the model.</p>
+ *
+ * @throws {@link ModelNotReadyException} (client fault)
+ *  <p>The model specified in the request is not ready to serve inference requests.</p>
+ *
+ * @throws {@link ModelStreamErrorException} (client fault)
+ *  <p>An error occurred while streaming the response. Retry your request.</p>
+ *
+ * @throws {@link ModelTimeoutException} (client fault)
+ *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ *  <p>The service isn't currently available. Try again later.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ * @public
+ */
+export declare class InvokeModelWithResponseStreamCommand extends InvokeModelWithResponseStreamCommand_base {
+}

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/commands/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./ApplyGuardrailCommand";
+export * from "./ConverseCommand";
+export * from "./ConverseStreamCommand";
+export * from "./InvokeModelCommand";
+export * from "./InvokeModelWithResponseStreamCommand";

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/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/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/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/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/endpoint/ruleset.d.ts

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

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/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 BedrockRuntimeExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * <p>Describes the API operations for running inference using Amazon Bedrock models.</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./BedrockRuntimeClient";
+export * from "./BedrockRuntime";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { BedrockRuntimeExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./models";
+export { BedrockRuntimeServiceException } from "./models/BedrockRuntimeServiceException";

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/models/BedrockRuntimeServiceException.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 BedrockRuntime service.
+ */
+export declare class BedrockRuntimeServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/node_modules/@aws-amplify/ai-constructs/node_modules/@aws-sdk/client-bedrock-runtime/dist-types/models/index.d.ts

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