@aws-sdk/client-bedrock-runtime 3.699.0 → 3.705.0

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

@@ -0,0 +1,124 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import { StartAsyncInvokeRequest, StartAsyncInvokeResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartAsyncInvokeCommand}.
+ */
+export interface StartAsyncInvokeCommandInput extends StartAsyncInvokeRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartAsyncInvokeCommand}.
+ */
+export interface StartAsyncInvokeCommandOutput extends StartAsyncInvokeResponse, __MetadataBearer {
+}
+declare const StartAsyncInvokeCommand_base: {
+    new (input: StartAsyncInvokeCommandInput): import("@smithy/smithy-client").CommandImpl<StartAsyncInvokeCommandInput, StartAsyncInvokeCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartAsyncInvokeCommandInput): import("@smithy/smithy-client").CommandImpl<StartAsyncInvokeCommandInput, StartAsyncInvokeCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Starts an asynchronous invocation.</p>
+ *          <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action.</p>
+ *          <important>
+ *             <p>To deny all inference access to resources that you specify in the modelId field, you
+ *          need to deny access to the <code>bedrock:InvokeModel</code> and
+ *             <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
+ *          access to the resource through the Converse API actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a>). For more information see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference">Deny access for inference on specific models</a>.
+ *             </p>
+ *          </important>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, StartAsyncInvokeCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, StartAsyncInvokeCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // StartAsyncInvokeRequest
+ *   clientRequestToken: "STRING_VALUE",
+ *   modelId: "STRING_VALUE", // required
+ *   modelInput: "DOCUMENT_VALUE", // required
+ *   outputDataConfig: { // AsyncInvokeOutputDataConfig Union: only one key present
+ *     s3OutputDataConfig: { // AsyncInvokeS3OutputDataConfig
+ *       s3Uri: "STRING_VALUE", // required
+ *       kmsKeyId: "STRING_VALUE",
+ *       bucketOwner: "STRING_VALUE",
+ *     },
+ *   },
+ *   tags: [ // TagList
+ *     { // Tag
+ *       key: "STRING_VALUE", // required
+ *       value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new StartAsyncInvokeCommand(input);
+ * const response = await client.send(command);
+ * // { // StartAsyncInvokeResponse
+ * //   invocationArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param StartAsyncInvokeCommandInput - {@link StartAsyncInvokeCommandInput}
+ * @returns {@link StartAsyncInvokeCommandOutput}
+ * @see {@link StartAsyncInvokeCommandInput} for command's `input` shape.
+ * @see {@link StartAsyncInvokeCommandOutput} 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 you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Error occurred because of a conflict while performing an operation.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. For troubleshooting this error,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource ARN was not found. For troubleshooting this error,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</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. For troubleshooting this error,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
+ *          troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ * @public
+ */
+export declare class StartAsyncInvokeCommand extends StartAsyncInvokeCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartAsyncInvokeRequest;
+            output: StartAsyncInvokeResponse;
+        };
+        sdk: {
+            input: StartAsyncInvokeCommandInput;
+            output: StartAsyncInvokeCommandOutput;
+        };
+    };
+}

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

@@ -1,5 +1,8 @@
 export * from "./ApplyGuardrailCommand";
 export * from "./ConverseCommand";
 export * from "./ConverseStreamCommand";
+export * from "./GetAsyncInvokeCommand";
 export * from "./InvokeModelCommand";
 export * from "./InvokeModelWithResponseStreamCommand";
+export * from "./ListAsyncInvokesCommand";
+export * from "./StartAsyncInvokeCommand";

package/dist-types/index.d.ts

@@ -9,5 +9,6 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export type { RuntimeExtension } from "./runtimeExtensions";
 export type { BedrockRuntimeExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
+export * from "./pagination";
 export * from "./models";
 export { BedrockRuntimeServiceException } from "./models/BedrockRuntimeServiceException";