@aws-sdk/client-bedrock-runtime 3.699.0 → 3.705.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -7
- package/dist-cjs/index.js +484 -116
- package/dist-es/BedrockRuntime.js +6 -0
- package/dist-es/commands/GetAsyncInvokeCommand.js +23 -0
- package/dist-es/commands/ListAsyncInvokesCommand.js +23 -0
- package/dist-es/commands/StartAsyncInvokeCommand.js +23 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +156 -72
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAsyncInvokesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +200 -2
- package/dist-types/BedrockRuntime.d.ts +22 -0
- package/dist-types/BedrockRuntimeClient.d.ts +5 -2
- package/dist-types/commands/ApplyGuardrailCommand.d.ts +12 -5
- package/dist-types/commands/ConverseCommand.d.ts +73 -9
- package/dist-types/commands/ConverseStreamCommand.d.ts +53 -9
- package/dist-types/commands/GetAsyncInvokeCommand.d.ts +101 -0
- package/dist-types/commands/InvokeModelCommand.d.ts +26 -9
- package/dist-types/commands/InvokeModelWithResponseStreamCommand.d.ts +26 -9
- package/dist-types/commands/ListAsyncInvokesCommand.d.ts +112 -0
- package/dist-types/commands/StartAsyncInvokeCommand.d.ts +124 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +652 -97
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAsyncInvokesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/BedrockRuntime.d.ts +52 -0
- package/dist-types/ts3.4/BedrockRuntimeClient.d.ts +20 -2
- package/dist-types/ts3.4/commands/GetAsyncInvokeCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListAsyncInvokesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartAsyncInvokeCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +254 -42
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAsyncInvokesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +4 -2
|
@@ -48,6 +48,15 @@ declare const ConverseStreamCommand_base: {
|
|
|
48
48
|
* <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
49
49
|
* </p>
|
|
50
50
|
* <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
|
|
51
|
+
* <important>
|
|
52
|
+
* <p>To deny all inference access to resources that you specify in the modelId field, you
|
|
53
|
+
* need to deny access to the <code>bedrock:InvokeModel</code> and
|
|
54
|
+
* <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
|
|
55
|
+
* access to the resource through the base inference actions (<a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html">InvokeModel</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html">InvokeModelWithResponseStream</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>.
|
|
56
|
+
* </p>
|
|
57
|
+
* </important>
|
|
58
|
+
* <p>For troubleshooting some of the common errors you might encounter when using the <code>ConverseStream</code> API,
|
|
59
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
|
|
51
60
|
* @example
|
|
52
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
53
62
|
* ```javascript
|
|
@@ -75,6 +84,16 @@ declare const ConverseStreamCommand_base: {
|
|
|
75
84
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
76
85
|
* },
|
|
77
86
|
* },
|
|
87
|
+
* video: { // VideoBlock
|
|
88
|
+
* format: "mkv" || "mov" || "mp4" || "webm" || "flv" || "mpeg" || "mpg" || "wmv" || "three_gp", // required
|
|
89
|
+
* source: { // VideoSource Union: only one key present
|
|
90
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
91
|
+
* s3Location: { // S3Location
|
|
92
|
+
* uri: "STRING_VALUE", // required
|
|
93
|
+
* bucketOwner: "STRING_VALUE",
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
96
|
+
* },
|
|
78
97
|
* toolUse: { // ToolUseBlock
|
|
79
98
|
* toolUseId: "STRING_VALUE", // required
|
|
80
99
|
* name: "STRING_VALUE", // required
|
|
@@ -99,6 +118,16 @@ declare const ConverseStreamCommand_base: {
|
|
|
99
118
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
100
119
|
* },
|
|
101
120
|
* },
|
|
121
|
+
* video: {
|
|
122
|
+
* format: "mkv" || "mov" || "mp4" || "webm" || "flv" || "mpeg" || "mpg" || "wmv" || "three_gp", // required
|
|
123
|
+
* source: {// Union: only one key present
|
|
124
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
125
|
+
* s3Location: {
|
|
126
|
+
* uri: "STRING_VALUE", // required
|
|
127
|
+
* bucketOwner: "STRING_VALUE",
|
|
128
|
+
* },
|
|
129
|
+
* },
|
|
130
|
+
* },
|
|
102
131
|
* },
|
|
103
132
|
* ],
|
|
104
133
|
* status: "success" || "error",
|
|
@@ -171,6 +200,12 @@ declare const ConverseStreamCommand_base: {
|
|
|
171
200
|
* additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
|
|
172
201
|
* "STRING_VALUE",
|
|
173
202
|
* ],
|
|
203
|
+
* requestMetadata: { // RequestMetadata
|
|
204
|
+
* "<keys>": "STRING_VALUE",
|
|
205
|
+
* },
|
|
206
|
+
* performanceConfig: { // PerformanceConfiguration
|
|
207
|
+
* latency: "standard" || "optimized",
|
|
208
|
+
* },
|
|
174
209
|
* };
|
|
175
210
|
* const command = new ConverseStreamCommand(input);
|
|
176
211
|
* const response = await client.send(command);
|
|
@@ -386,6 +421,9 @@ declare const ConverseStreamCommand_base: {
|
|
|
386
421
|
* // },
|
|
387
422
|
* // },
|
|
388
423
|
* // },
|
|
424
|
+
* // performanceConfig: { // PerformanceConfiguration
|
|
425
|
+
* // latency: "standard" || "optimized",
|
|
426
|
+
* // },
|
|
389
427
|
* // },
|
|
390
428
|
* // internalServerException: { // InternalServerException
|
|
391
429
|
* // message: "STRING_VALUE",
|
|
@@ -416,34 +454,40 @@ declare const ConverseStreamCommand_base: {
|
|
|
416
454
|
* @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
|
|
417
455
|
*
|
|
418
456
|
* @throws {@link AccessDeniedException} (client fault)
|
|
419
|
-
* <p>The request is denied because
|
|
457
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
458
|
+
* 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>
|
|
420
459
|
*
|
|
421
460
|
* @throws {@link InternalServerException} (server fault)
|
|
422
|
-
* <p>An internal server error occurred.
|
|
461
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
462
|
+
* 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>
|
|
423
463
|
*
|
|
424
464
|
* @throws {@link ModelErrorException} (client fault)
|
|
425
465
|
* <p>The request failed due to an error while processing the model.</p>
|
|
426
466
|
*
|
|
427
467
|
* @throws {@link ModelNotReadyException} (client fault)
|
|
428
468
|
* <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
469
|
+
* will automatically retry the operation up to 5 times. For information about configuring
|
|
470
|
+
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
471
|
+
* reference guide.</p>
|
|
432
472
|
*
|
|
433
473
|
* @throws {@link ModelTimeoutException} (client fault)
|
|
434
474
|
* <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
|
|
435
475
|
*
|
|
436
476
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
437
|
-
* <p>The specified resource ARN was not found.
|
|
477
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
478
|
+
* 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>
|
|
438
479
|
*
|
|
439
480
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
440
|
-
* <p>The service isn't currently available.
|
|
481
|
+
* <p>The service isn't currently available. For troubleshooting this error,
|
|
482
|
+
* 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>
|
|
441
483
|
*
|
|
442
484
|
* @throws {@link ThrottlingException} (client fault)
|
|
443
|
-
* <p>Your request was
|
|
485
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
486
|
+
* 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>
|
|
444
487
|
*
|
|
445
488
|
* @throws {@link ValidationException} (client fault)
|
|
446
|
-
* <p>
|
|
489
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
490
|
+
* 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>
|
|
447
491
|
*
|
|
448
492
|
* @throws {@link BedrockRuntimeServiceException}
|
|
449
493
|
* <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
|
|
4
|
+
import { GetAsyncInvokeRequest, GetAsyncInvokeResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetAsyncInvokeCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAsyncInvokeCommandInput extends GetAsyncInvokeRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAsyncInvokeCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAsyncInvokeCommandOutput extends GetAsyncInvokeResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetAsyncInvokeCommand_base: {
|
|
25
|
+
new (input: GetAsyncInvokeCommandInput): import("@smithy/smithy-client").CommandImpl<GetAsyncInvokeCommandInput, GetAsyncInvokeCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetAsyncInvokeCommandInput): import("@smithy/smithy-client").CommandImpl<GetAsyncInvokeCommandInput, GetAsyncInvokeCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieve information about an asynchronous invocation.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockRuntimeClient, GetAsyncInvokeCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockRuntimeClient, GetAsyncInvokeCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockRuntimeClient(config);
|
|
37
|
+
* const input = { // GetAsyncInvokeRequest
|
|
38
|
+
* invocationArn: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetAsyncInvokeCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetAsyncInvokeResponse
|
|
43
|
+
* // invocationArn: "STRING_VALUE", // required
|
|
44
|
+
* // modelArn: "STRING_VALUE", // required
|
|
45
|
+
* // clientRequestToken: "STRING_VALUE",
|
|
46
|
+
* // status: "InProgress" || "Completed" || "Failed", // required
|
|
47
|
+
* // failureMessage: "STRING_VALUE",
|
|
48
|
+
* // submitTime: new Date("TIMESTAMP"), // required
|
|
49
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
50
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
51
|
+
* // outputDataConfig: { // AsyncInvokeOutputDataConfig Union: only one key present
|
|
52
|
+
* // s3OutputDataConfig: { // AsyncInvokeS3OutputDataConfig
|
|
53
|
+
* // s3Uri: "STRING_VALUE", // required
|
|
54
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
55
|
+
* // bucketOwner: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param GetAsyncInvokeCommandInput - {@link GetAsyncInvokeCommandInput}
|
|
63
|
+
* @returns {@link GetAsyncInvokeCommandOutput}
|
|
64
|
+
* @see {@link GetAsyncInvokeCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link GetAsyncInvokeCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
69
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
70
|
+
* 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>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
74
|
+
* 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>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
78
|
+
* 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>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ValidationException} (client fault)
|
|
81
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
82
|
+
* 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>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link BedrockRuntimeServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export declare class GetAsyncInvokeCommand extends GetAsyncInvokeCommand_base {
|
|
90
|
+
/** @internal type navigation helper, not in runtime. */
|
|
91
|
+
protected static __types: {
|
|
92
|
+
api: {
|
|
93
|
+
input: GetAsyncInvokeRequest;
|
|
94
|
+
output: GetAsyncInvokeResponse;
|
|
95
|
+
};
|
|
96
|
+
sdk: {
|
|
97
|
+
input: GetAsyncInvokeCommandInput;
|
|
98
|
+
output: GetAsyncInvokeCommandOutput;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
}
|
|
@@ -45,6 +45,15 @@ declare const InvokeModelCommand_base: {
|
|
|
45
45
|
* <p>For example code, see <i>Invoke model code examples</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
46
46
|
* </p>
|
|
47
47
|
* <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action.</p>
|
|
48
|
+
* <important>
|
|
49
|
+
* <p>To deny all inference access to resources that you specify in the modelId field, you
|
|
50
|
+
* need to deny access to the <code>bedrock:InvokeModel</code> and
|
|
51
|
+
* <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
|
|
52
|
+
* 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>.
|
|
53
|
+
* </p>
|
|
54
|
+
* </important>
|
|
55
|
+
* <p>For troubleshooting some of the common errors you might encounter when using the <code>InvokeModel</code> API,
|
|
56
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
|
|
48
57
|
* @example
|
|
49
58
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
59
|
* ```javascript
|
|
@@ -59,12 +68,14 @@ declare const InvokeModelCommand_base: {
|
|
|
59
68
|
* trace: "ENABLED" || "DISABLED",
|
|
60
69
|
* guardrailIdentifier: "STRING_VALUE",
|
|
61
70
|
* guardrailVersion: "STRING_VALUE",
|
|
71
|
+
* performanceConfigLatency: "standard" || "optimized",
|
|
62
72
|
* };
|
|
63
73
|
* const command = new InvokeModelCommand(input);
|
|
64
74
|
* const response = await client.send(command);
|
|
65
75
|
* // { // InvokeModelResponse
|
|
66
76
|
* // body: new Uint8Array(), // required
|
|
67
77
|
* // contentType: "STRING_VALUE", // required
|
|
78
|
+
* // performanceConfigLatency: "standard" || "optimized",
|
|
68
79
|
* // };
|
|
69
80
|
*
|
|
70
81
|
* ```
|
|
@@ -76,37 +87,43 @@ declare const InvokeModelCommand_base: {
|
|
|
76
87
|
* @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
|
|
77
88
|
*
|
|
78
89
|
* @throws {@link AccessDeniedException} (client fault)
|
|
79
|
-
* <p>The request is denied because
|
|
90
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
91
|
+
* 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>
|
|
80
92
|
*
|
|
81
93
|
* @throws {@link InternalServerException} (server fault)
|
|
82
|
-
* <p>An internal server error occurred.
|
|
94
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
95
|
+
* 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>
|
|
83
96
|
*
|
|
84
97
|
* @throws {@link ModelErrorException} (client fault)
|
|
85
98
|
* <p>The request failed due to an error while processing the model.</p>
|
|
86
99
|
*
|
|
87
100
|
* @throws {@link ModelNotReadyException} (client fault)
|
|
88
101
|
* <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
102
|
+
* will automatically retry the operation up to 5 times. For information about configuring
|
|
103
|
+
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
104
|
+
* reference guide.</p>
|
|
92
105
|
*
|
|
93
106
|
* @throws {@link ModelTimeoutException} (client fault)
|
|
94
107
|
* <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
|
|
95
108
|
*
|
|
96
109
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
97
|
-
* <p>The specified resource ARN was not found.
|
|
110
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
111
|
+
* 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>
|
|
98
112
|
*
|
|
99
113
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
100
114
|
* <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>
|
|
101
115
|
*
|
|
102
116
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
103
|
-
* <p>The service isn't currently available.
|
|
117
|
+
* <p>The service isn't currently available. For troubleshooting this error,
|
|
118
|
+
* 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>
|
|
104
119
|
*
|
|
105
120
|
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
-
* <p>Your request was
|
|
121
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
122
|
+
* 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>
|
|
107
123
|
*
|
|
108
124
|
* @throws {@link ValidationException} (client fault)
|
|
109
|
-
* <p>
|
|
125
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
126
|
+
* 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>
|
|
110
127
|
*
|
|
111
128
|
* @throws {@link BedrockRuntimeServiceException}
|
|
112
129
|
* <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
|
|
@@ -43,6 +43,15 @@ declare const InvokeModelWithResponseStreamCommand_base: {
|
|
|
43
43
|
* example</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
44
44
|
* </p>
|
|
45
45
|
* <p>This operation requires permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action. </p>
|
|
46
|
+
* <important>
|
|
47
|
+
* <p>To deny all inference access to resources that you specify in the modelId field, you
|
|
48
|
+
* need to deny access to the <code>bedrock:InvokeModel</code> and
|
|
49
|
+
* <code>bedrock:InvokeModelWithResponseStream</code> actions. Doing this also denies
|
|
50
|
+
* 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>.
|
|
51
|
+
* </p>
|
|
52
|
+
* </important>
|
|
53
|
+
* <p>For troubleshooting some of the common errors you might encounter when using the <code>InvokeModelWithResponseStream</code> API,
|
|
54
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html">Troubleshooting Amazon Bedrock API Error Codes</a> in the Amazon Bedrock User Guide</p>
|
|
46
55
|
* @example
|
|
47
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
57
|
* ```javascript
|
|
@@ -57,6 +66,7 @@ declare const InvokeModelWithResponseStreamCommand_base: {
|
|
|
57
66
|
* trace: "ENABLED" || "DISABLED",
|
|
58
67
|
* guardrailIdentifier: "STRING_VALUE",
|
|
59
68
|
* guardrailVersion: "STRING_VALUE",
|
|
69
|
+
* performanceConfigLatency: "standard" || "optimized",
|
|
60
70
|
* };
|
|
61
71
|
* const command = new InvokeModelWithResponseStreamCommand(input);
|
|
62
72
|
* const response = await client.send(command);
|
|
@@ -87,6 +97,7 @@ declare const InvokeModelWithResponseStreamCommand_base: {
|
|
|
87
97
|
* // },
|
|
88
98
|
* // },
|
|
89
99
|
* // contentType: "STRING_VALUE", // required
|
|
100
|
+
* // performanceConfigLatency: "standard" || "optimized",
|
|
90
101
|
* // };
|
|
91
102
|
*
|
|
92
103
|
* ```
|
|
@@ -98,19 +109,21 @@ declare const InvokeModelWithResponseStreamCommand_base: {
|
|
|
98
109
|
* @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
|
|
99
110
|
*
|
|
100
111
|
* @throws {@link AccessDeniedException} (client fault)
|
|
101
|
-
* <p>The request is denied because
|
|
112
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
113
|
+
* 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>
|
|
102
114
|
*
|
|
103
115
|
* @throws {@link InternalServerException} (server fault)
|
|
104
|
-
* <p>An internal server error occurred.
|
|
116
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
117
|
+
* 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>
|
|
105
118
|
*
|
|
106
119
|
* @throws {@link ModelErrorException} (client fault)
|
|
107
120
|
* <p>The request failed due to an error while processing the model.</p>
|
|
108
121
|
*
|
|
109
122
|
* @throws {@link ModelNotReadyException} (client fault)
|
|
110
123
|
* <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
124
|
+
* will automatically retry the operation up to 5 times. For information about configuring
|
|
125
|
+
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
126
|
+
* reference guide.</p>
|
|
114
127
|
*
|
|
115
128
|
* @throws {@link ModelStreamErrorException} (client fault)
|
|
116
129
|
* <p>An error occurred while streaming the response. Retry your request.</p>
|
|
@@ -119,19 +132,23 @@ declare const InvokeModelWithResponseStreamCommand_base: {
|
|
|
119
132
|
* <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
|
|
120
133
|
*
|
|
121
134
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
122
|
-
* <p>The specified resource ARN was not found.
|
|
135
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
136
|
+
* 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>
|
|
123
137
|
*
|
|
124
138
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
125
139
|
* <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>
|
|
126
140
|
*
|
|
127
141
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
128
|
-
* <p>The service isn't currently available.
|
|
142
|
+
* <p>The service isn't currently available. For troubleshooting this error,
|
|
143
|
+
* 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>
|
|
129
144
|
*
|
|
130
145
|
* @throws {@link ThrottlingException} (client fault)
|
|
131
|
-
* <p>Your request was
|
|
146
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
147
|
+
* 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>
|
|
132
148
|
*
|
|
133
149
|
* @throws {@link ValidationException} (client fault)
|
|
134
|
-
* <p>
|
|
150
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
151
|
+
* 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>
|
|
135
152
|
*
|
|
136
153
|
* @throws {@link BedrockRuntimeServiceException}
|
|
137
154
|
* <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
|
|
4
|
+
import { ListAsyncInvokesRequest, ListAsyncInvokesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAsyncInvokesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAsyncInvokesCommandInput extends ListAsyncInvokesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAsyncInvokesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAsyncInvokesCommandOutput extends ListAsyncInvokesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAsyncInvokesCommand_base: {
|
|
25
|
+
new (input: ListAsyncInvokesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAsyncInvokesCommandInput, ListAsyncInvokesCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListAsyncInvokesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListAsyncInvokesCommandInput, ListAsyncInvokesCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists asynchronous invocations.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { BedrockRuntimeClient, ListAsyncInvokesCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
|
|
35
|
+
* // const { BedrockRuntimeClient, ListAsyncInvokesCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
|
|
36
|
+
* const client = new BedrockRuntimeClient(config);
|
|
37
|
+
* const input = { // ListAsyncInvokesRequest
|
|
38
|
+
* submitTimeAfter: new Date("TIMESTAMP"),
|
|
39
|
+
* submitTimeBefore: new Date("TIMESTAMP"),
|
|
40
|
+
* statusEquals: "InProgress" || "Completed" || "Failed",
|
|
41
|
+
* maxResults: Number("int"),
|
|
42
|
+
* nextToken: "STRING_VALUE",
|
|
43
|
+
* sortBy: "SubmissionTime",
|
|
44
|
+
* sortOrder: "Ascending" || "Descending",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListAsyncInvokesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListAsyncInvokesResponse
|
|
49
|
+
* // nextToken: "STRING_VALUE",
|
|
50
|
+
* // asyncInvokeSummaries: [ // AsyncInvokeSummaries
|
|
51
|
+
* // { // AsyncInvokeSummary
|
|
52
|
+
* // invocationArn: "STRING_VALUE", // required
|
|
53
|
+
* // modelArn: "STRING_VALUE", // required
|
|
54
|
+
* // clientRequestToken: "STRING_VALUE",
|
|
55
|
+
* // status: "InProgress" || "Completed" || "Failed",
|
|
56
|
+
* // failureMessage: "STRING_VALUE",
|
|
57
|
+
* // submitTime: new Date("TIMESTAMP"), // required
|
|
58
|
+
* // lastModifiedTime: new Date("TIMESTAMP"),
|
|
59
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
60
|
+
* // outputDataConfig: { // AsyncInvokeOutputDataConfig Union: only one key present
|
|
61
|
+
* // s3OutputDataConfig: { // AsyncInvokeS3OutputDataConfig
|
|
62
|
+
* // s3Uri: "STRING_VALUE", // required
|
|
63
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
64
|
+
* // bucketOwner: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* @param ListAsyncInvokesCommandInput - {@link ListAsyncInvokesCommandInput}
|
|
74
|
+
* @returns {@link ListAsyncInvokesCommandOutput}
|
|
75
|
+
* @see {@link ListAsyncInvokesCommandInput} for command's `input` shape.
|
|
76
|
+
* @see {@link ListAsyncInvokesCommandOutput} for command's `response` shape.
|
|
77
|
+
* @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
81
|
+
* 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>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerException} (server fault)
|
|
84
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
85
|
+
* 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>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
88
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
89
|
+
* 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>
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ValidationException} (client fault)
|
|
92
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
93
|
+
* 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>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link BedrockRuntimeServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export declare class ListAsyncInvokesCommand extends ListAsyncInvokesCommand_base {
|
|
101
|
+
/** @internal type navigation helper, not in runtime. */
|
|
102
|
+
protected static __types: {
|
|
103
|
+
api: {
|
|
104
|
+
input: ListAsyncInvokesRequest;
|
|
105
|
+
output: ListAsyncInvokesResponse;
|
|
106
|
+
};
|
|
107
|
+
sdk: {
|
|
108
|
+
input: ListAsyncInvokesCommandInput;
|
|
109
|
+
output: ListAsyncInvokesCommandOutput;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
}
|