@aws-sdk/client-bedrock 3.554.0 → 3.561.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.
Files changed (74) hide show
  1. package/README.md +81 -1
  2. package/dist-cjs/index.js +1005 -79
  3. package/dist-es/Bedrock.js +20 -0
  4. package/dist-es/commands/CreateEvaluationJobCommand.js +25 -0
  5. package/dist-es/commands/CreateGuardrailCommand.js +25 -0
  6. package/dist-es/commands/CreateGuardrailVersionCommand.js +25 -0
  7. package/dist-es/commands/DeleteGuardrailCommand.js +24 -0
  8. package/dist-es/commands/GetEvaluationJobCommand.js +25 -0
  9. package/dist-es/commands/GetGuardrailCommand.js +25 -0
  10. package/dist-es/commands/ListEvaluationJobsCommand.js +24 -0
  11. package/dist-es/commands/ListGuardrailsCommand.js +25 -0
  12. package/dist-es/commands/StopEvaluationJobCommand.js +25 -0
  13. package/dist-es/commands/UpdateGuardrailCommand.js +25 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +312 -48
  16. package/dist-es/pagination/ListEvaluationJobsPaginator.js +4 -0
  17. package/dist-es/pagination/ListGuardrailsPaginator.js +4 -0
  18. package/dist-es/pagination/index.js +2 -0
  19. package/dist-es/protocols/Aws_restJson1.js +374 -4
  20. package/dist-types/Bedrock.d.ts +73 -1
  21. package/dist-types/BedrockClient.d.ts +13 -3
  22. package/dist-types/commands/CreateEvaluationJobCommand.d.ts +148 -0
  23. package/dist-types/commands/CreateGuardrailCommand.d.ts +186 -0
  24. package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +84 -0
  25. package/dist-types/commands/CreateModelCustomizationJobCommand.d.ts +6 -8
  26. package/dist-types/commands/CreateProvisionedModelThroughputCommand.d.ts +2 -3
  27. package/dist-types/commands/DeleteCustomModelCommand.d.ts +2 -2
  28. package/dist-types/commands/DeleteGuardrailCommand.d.ts +84 -0
  29. package/dist-types/commands/DeleteProvisionedModelThroughputCommand.d.ts +2 -2
  30. package/dist-types/commands/GetCustomModelCommand.d.ts +2 -2
  31. package/dist-types/commands/GetEvaluationJobCommand.d.ts +144 -0
  32. package/dist-types/commands/GetFoundationModelCommand.d.ts +1 -1
  33. package/dist-types/commands/GetGuardrailCommand.d.ts +140 -0
  34. package/dist-types/commands/GetModelCustomizationJobCommand.d.ts +2 -2
  35. package/dist-types/commands/GetProvisionedModelThroughputCommand.d.ts +2 -2
  36. package/dist-types/commands/ListCustomModelsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListEvaluationJobsCommand.d.ts +93 -0
  38. package/dist-types/commands/ListFoundationModelsCommand.d.ts +1 -1
  39. package/dist-types/commands/ListGuardrailsCommand.d.ts +89 -0
  40. package/dist-types/commands/ListModelCustomizationJobsCommand.d.ts +2 -2
  41. package/dist-types/commands/ListProvisionedModelThroughputsCommand.d.ts +1 -1
  42. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  43. package/dist-types/commands/StopEvaluationJobCommand.d.ts +75 -0
  44. package/dist-types/commands/StopModelCustomizationJobCommand.d.ts +2 -2
  45. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  46. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  47. package/dist-types/commands/UpdateGuardrailCommand.d.ts +176 -0
  48. package/dist-types/commands/UpdateProvisionedModelThroughputCommand.d.ts +2 -2
  49. package/dist-types/commands/index.d.ts +10 -0
  50. package/dist-types/index.d.ts +1 -1
  51. package/dist-types/models/models_0.d.ts +1926 -215
  52. package/dist-types/pagination/ListEvaluationJobsPaginator.d.ts +7 -0
  53. package/dist-types/pagination/ListGuardrailsPaginator.d.ts +7 -0
  54. package/dist-types/pagination/index.d.ts +2 -0
  55. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  56. package/dist-types/ts3.4/Bedrock.d.ts +172 -0
  57. package/dist-types/ts3.4/BedrockClient.d.ts +60 -0
  58. package/dist-types/ts3.4/commands/CreateEvaluationJobCommand.d.ts +39 -0
  59. package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +38 -0
  60. package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +39 -0
  61. package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +38 -0
  62. package/dist-types/ts3.4/commands/GetEvaluationJobCommand.d.ts +38 -0
  63. package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +35 -0
  64. package/dist-types/ts3.4/commands/ListEvaluationJobsCommand.d.ts +39 -0
  65. package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +38 -0
  66. package/dist-types/ts3.4/commands/StopEvaluationJobCommand.d.ts +39 -0
  67. package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +38 -0
  68. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  69. package/dist-types/ts3.4/models/models_0.d.ts +572 -49
  70. package/dist-types/ts3.4/pagination/ListEvaluationJobsPaginator.d.ts +11 -0
  71. package/dist-types/ts3.4/pagination/ListGuardrailsPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  73. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  74. package/package.json +4 -4
@@ -13,38 +13,1735 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
+ * <p>Error occurred because of a conflict while performing an operation.</p>
17
+ * @public
18
+ */
19
+ export declare class ConflictException extends __BaseException {
20
+ readonly name: "ConflictException";
21
+ readonly $fault: "client";
22
+ /**
23
+ * @internal
24
+ */
25
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
26
+ }
27
+ /**
28
+ * <p>The location in Amazon S3 where your prompt dataset is stored.</p>
29
+ * @public
30
+ */
31
+ export type EvaluationDatasetLocation = EvaluationDatasetLocation.S3UriMember | EvaluationDatasetLocation.$UnknownMember;
32
+ /**
33
+ * @public
34
+ */
35
+ export declare namespace EvaluationDatasetLocation {
36
+ /**
37
+ * <p>The S3 URI of the S3 bucket specified in the job.</p>
38
+ * @public
39
+ */
40
+ interface S3UriMember {
41
+ s3Uri: string;
42
+ $unknown?: never;
43
+ }
44
+ /**
45
+ * @public
46
+ */
47
+ interface $UnknownMember {
48
+ s3Uri?: never;
49
+ $unknown: [string, any];
50
+ }
51
+ interface Visitor<T> {
52
+ s3Uri: (value: string) => T;
53
+ _: (name: string, value: any) => T;
54
+ }
55
+ const visit: <T>(value: EvaluationDatasetLocation, visitor: Visitor<T>) => T;
56
+ }
57
+ /**
58
+ * <p>Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.</p>
59
+ * @public
60
+ */
61
+ export interface EvaluationDataset {
62
+ /**
63
+ * <p>Used to specify supported built-in prompt datasets. Valid values are <code>Builtin.Bold</code>, <code>Builtin.BoolQ</code>, <code>Builtin.NaturalQuestions</code>, <code>Builtin.Gigaword</code>, <code>Builtin.RealToxicityPrompts</code>, <code>Builtin.TriviaQa</code>, <code>Builtin.T-Rex</code>, <code>Builtin.WomensEcommerceClothingReviews</code> and <code>Builtin.Wikitext2</code>.</p>
64
+ * @public
65
+ */
66
+ name: string | undefined;
67
+ /**
68
+ * <p>For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.</p>
69
+ * @public
70
+ */
71
+ datasetLocation?: EvaluationDatasetLocation;
72
+ }
73
+ /**
74
+ * @public
75
+ * @enum
76
+ */
77
+ export declare const EvaluationTaskType: {
78
+ readonly CLASSIFICATION: "Classification";
79
+ readonly CUSTOM: "Custom";
80
+ readonly GENERATION: "Generation";
81
+ readonly QUESTION_AND_ANSWER: "QuestionAndAnswer";
82
+ readonly SUMMARIZATION: "Summarization";
83
+ };
84
+ /**
85
+ * @public
86
+ */
87
+ export type EvaluationTaskType = (typeof EvaluationTaskType)[keyof typeof EvaluationTaskType];
88
+ /**
89
+ * <p>Defines the built-in prompt datasets, built-in metric names and custom metric names, and the task type.</p>
90
+ * @public
91
+ */
92
+ export interface EvaluationDatasetMetricConfig {
93
+ /**
94
+ * <p>The task type you want the model to carry out. </p>
95
+ * @public
96
+ */
97
+ taskType: EvaluationTaskType | undefined;
98
+ /**
99
+ * <p>Specifies the prompt dataset.</p>
100
+ * @public
101
+ */
102
+ dataset: EvaluationDataset | undefined;
103
+ /**
104
+ * <p>The names of the metrics used. For automated model evaluation jobs valid values are <code>"Builtin.Accuracy"</code>, <code>"Builtin.Robustness"</code>, and <code>"Builtin.Toxicity"</code>. In human-based model evaluation jobs the array of strings must match the <code>name</code> parameter specified in <code>HumanEvaluationCustomMetric</code>. </p>
105
+ * @public
106
+ */
107
+ metricNames: string[] | undefined;
108
+ }
109
+ /**
110
+ * <p>Use to specify a automatic model evaluation job. The <code>EvaluationDatasetMetricConfig</code> object is used to specify the prompt datasets, task type, and metric names.</p>
111
+ * @public
112
+ */
113
+ export interface AutomatedEvaluationConfig {
114
+ /**
115
+ * <p>Specifies the required elements for an automatic model evaluation job.</p>
116
+ * @public
117
+ */
118
+ datasetMetricConfigs: EvaluationDatasetMetricConfig[] | undefined;
119
+ }
120
+ /**
121
+ * <p>In a model evaluation job that uses human workers you must
122
+ * define the name of the metric, and how you want that metric rated
123
+ * <code>ratingMethod</code>, and an optional description of the metric.</p>
124
+ * @public
125
+ */
126
+ export interface HumanEvaluationCustomMetric {
127
+ /**
128
+ * <p>The name of the metric. Your human evaluators will see this name in the evaluation UI.</p>
129
+ * @public
130
+ */
131
+ name: string | undefined;
132
+ /**
133
+ * <p>An optional description of the metric. Use this parameter to provide more details about the metric.</p>
134
+ * @public
135
+ */
136
+ description?: string;
137
+ /**
138
+ * <p>Choose how you want your human workers to evaluation your model. Valid values for rating methods are <code>ThumbsUpDown</code>, <code>IndividualLikertScale</code>,<code>ComparisonLikertScale</code>, <code>ComparisonChoice</code>, and <code>ComparisonRank</code>
139
+ * </p>
140
+ * @public
141
+ */
142
+ ratingMethod: string | undefined;
143
+ }
144
+ /**
145
+ * <p>Contains <code>SageMakerFlowDefinition</code> object. The object is used to specify the prompt dataset, task type, rating method and metric names.</p>
146
+ * @public
147
+ */
148
+ export interface HumanWorkflowConfig {
149
+ /**
150
+ * <p>The Amazon Resource Number (ARN) for the flow definition</p>
151
+ * @public
152
+ */
153
+ flowDefinitionArn: string | undefined;
154
+ /**
155
+ * <p>Instructions for the flow definition</p>
156
+ * @public
157
+ */
158
+ instructions?: string;
159
+ }
160
+ /**
161
+ * <p>Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers <i>only</i> support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html">Custom prompt datasets</a>.</p>
162
+ * <p>When you create custom metrics in <code>HumanEvaluationCustomMetric</code> you must specify the metric's <code>name</code>. The list of <code>names</code> specified in the <code>HumanEvaluationCustomMetric</code> array, must match the <code>metricNames</code> array of strings specified in <code>EvaluationDatasetMetricConfig</code>. For example, if in the <code>HumanEvaluationCustomMetric</code> array your specified the names <code>"accuracy", "toxicity", "readability"</code> as custom metrics <i>then</i> the <code>metricNames</code> array would need to look like the following <code>["accuracy", "toxicity", "readability"]</code> in <code>EvaluationDatasetMetricConfig</code>.</p>
163
+ * @public
164
+ */
165
+ export interface HumanEvaluationConfig {
166
+ /**
167
+ * <p>The parameters of the human workflow.</p>
168
+ * @public
169
+ */
170
+ humanWorkflowConfig?: HumanWorkflowConfig;
171
+ /**
172
+ * <p>A <code>HumanEvaluationCustomMetric</code> object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.</p>
173
+ * @public
174
+ */
175
+ customMetrics?: HumanEvaluationCustomMetric[];
176
+ /**
177
+ * <p>Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.</p>
178
+ * @public
179
+ */
180
+ datasetMetricConfigs: EvaluationDatasetMetricConfig[] | undefined;
181
+ }
182
+ /**
183
+ * <p>Used to specify either a <code>AutomatedEvaluationConfig</code> or <code>HumanEvaluationConfig</code> object.</p>
184
+ * @public
185
+ */
186
+ export type EvaluationConfig = EvaluationConfig.AutomatedMember | EvaluationConfig.HumanMember | EvaluationConfig.$UnknownMember;
187
+ /**
188
+ * @public
189
+ */
190
+ export declare namespace EvaluationConfig {
191
+ /**
192
+ * <p>Used to specify an automated model evaluation job.
193
+ * See <code>AutomatedEvaluationConfig</code> to view the required parameters.</p>
194
+ * @public
195
+ */
196
+ interface AutomatedMember {
197
+ automated: AutomatedEvaluationConfig;
198
+ human?: never;
199
+ $unknown?: never;
200
+ }
201
+ /**
202
+ * <p>Used to specify a model evaluation job that uses human workers.See <code>HumanEvaluationConfig</code> to view the required parameters.</p>
203
+ * @public
204
+ */
205
+ interface HumanMember {
206
+ automated?: never;
207
+ human: HumanEvaluationConfig;
208
+ $unknown?: never;
209
+ }
210
+ /**
211
+ * @public
212
+ */
213
+ interface $UnknownMember {
214
+ automated?: never;
215
+ human?: never;
216
+ $unknown: [string, any];
217
+ }
218
+ interface Visitor<T> {
219
+ automated: (value: AutomatedEvaluationConfig) => T;
220
+ human: (value: HumanEvaluationConfig) => T;
221
+ _: (name: string, value: any) => T;
222
+ }
223
+ const visit: <T>(value: EvaluationConfig, visitor: Visitor<T>) => T;
224
+ }
225
+ /**
226
+ * <p>Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different <code>inferenceParams</code>. To learn more about supported inference parameters for Amazon Bedrock models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html">Inference parameters for foundation models</a>.</p>
227
+ * <p>The <code>inferenceParams</code> are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, <code>"temperature":"0.25"</code> key value pair would need to be formatted as <code>\"temperature\":\"0.25\"</code> to successfully accepted in the request.</p>
228
+ * @public
229
+ */
230
+ export interface EvaluationBedrockModel {
231
+ /**
232
+ * <p>The ARN of the Amazon Bedrock model specified.</p>
233
+ * @public
234
+ */
235
+ modelIdentifier: string | undefined;
236
+ /**
237
+ * <p>Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.</p>
238
+ * @public
239
+ */
240
+ inferenceParams: string | undefined;
241
+ }
242
+ /**
243
+ * <p>Defines the models used in the model evaluation job.</p>
244
+ * @public
245
+ */
246
+ export type EvaluationModelConfig = EvaluationModelConfig.BedrockModelMember | EvaluationModelConfig.$UnknownMember;
247
+ /**
248
+ * @public
249
+ */
250
+ export declare namespace EvaluationModelConfig {
251
+ /**
252
+ * <p>Defines the Amazon Bedrock model and inference parameters you want used.</p>
253
+ * @public
254
+ */
255
+ interface BedrockModelMember {
256
+ bedrockModel: EvaluationBedrockModel;
257
+ $unknown?: never;
258
+ }
259
+ /**
260
+ * @public
261
+ */
262
+ interface $UnknownMember {
263
+ bedrockModel?: never;
264
+ $unknown: [string, any];
265
+ }
266
+ interface Visitor<T> {
267
+ bedrockModel: (value: EvaluationBedrockModel) => T;
268
+ _: (name: string, value: any) => T;
269
+ }
270
+ const visit: <T>(value: EvaluationModelConfig, visitor: Visitor<T>) => T;
271
+ }
272
+ /**
273
+ * <p>Used to define the models you want used in your model evaluation job. Automated model evaluation jobs support only a single model. In a human-based model evaluation job, your annotator can compare the responses for up to two different models.</p>
274
+ * @public
275
+ */
276
+ export type EvaluationInferenceConfig = EvaluationInferenceConfig.ModelsMember | EvaluationInferenceConfig.$UnknownMember;
277
+ /**
278
+ * @public
279
+ */
280
+ export declare namespace EvaluationInferenceConfig {
281
+ /**
282
+ * <p>Used to specify the models.</p>
283
+ * @public
284
+ */
285
+ interface ModelsMember {
286
+ models: EvaluationModelConfig[];
287
+ $unknown?: never;
288
+ }
289
+ /**
290
+ * @public
291
+ */
292
+ interface $UnknownMember {
293
+ models?: never;
294
+ $unknown: [string, any];
295
+ }
296
+ interface Visitor<T> {
297
+ models: (value: EvaluationModelConfig[]) => T;
298
+ _: (name: string, value: any) => T;
299
+ }
300
+ const visit: <T>(value: EvaluationInferenceConfig, visitor: Visitor<T>) => T;
301
+ }
302
+ /**
303
+ * <p>Definition of the key/value pair for a tag.</p>
304
+ * @public
305
+ */
306
+ export interface Tag {
307
+ /**
308
+ * <p>Key for the tag.</p>
309
+ * @public
310
+ */
311
+ key: string | undefined;
312
+ /**
313
+ * <p>Value for the tag.</p>
314
+ * @public
315
+ */
316
+ value: string | undefined;
317
+ }
318
+ /**
319
+ * <p>The Amazon S3 location where the results of your model evaluation job are saved.</p>
320
+ * @public
321
+ */
322
+ export interface EvaluationOutputDataConfig {
323
+ /**
324
+ * <p>The Amazon S3 URI where the results of model evaluation job are saved.</p>
325
+ * @public
326
+ */
327
+ s3Uri: string | undefined;
328
+ }
329
+ /**
330
+ * @public
331
+ */
332
+ export interface CreateEvaluationJobRequest {
333
+ /**
334
+ * <p>The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.</p>
335
+ * @public
336
+ */
337
+ jobName: string | undefined;
338
+ /**
339
+ * <p>A description of the model evaluation job.</p>
340
+ * @public
341
+ */
342
+ jobDescription?: string;
343
+ /**
344
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
345
+ * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
346
+ * @public
347
+ */
348
+ clientRequestToken?: string;
349
+ /**
350
+ * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the <code>EvaluationConfig</code> object. To pass this role to Amazon Bedrock, the caller of this API must have the <code>iam:PassRole</code> permission. To learn more about the required permissions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html">Required permissions</a>.</p>
351
+ * @public
352
+ */
353
+ roleArn: string | undefined;
354
+ /**
355
+ * <p>Specify your customer managed key ARN that will be used to encrypt your model evaluation job.</p>
356
+ * @public
357
+ */
358
+ customerEncryptionKeyId?: string;
359
+ /**
360
+ * <p>Tags to attach to the model evaluation job.</p>
361
+ * @public
362
+ */
363
+ jobTags?: Tag[];
364
+ /**
365
+ * <p>Specifies whether the model evaluation job is automatic or uses human worker.</p>
366
+ * @public
367
+ */
368
+ evaluationConfig: EvaluationConfig | undefined;
369
+ /**
370
+ * <p>Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.</p>
371
+ * @public
372
+ */
373
+ inferenceConfig: EvaluationInferenceConfig | undefined;
374
+ /**
375
+ * <p>An object that defines where the results of model evaluation job will be saved in Amazon S3.</p>
376
+ * @public
377
+ */
378
+ outputDataConfig: EvaluationOutputDataConfig | undefined;
379
+ }
380
+ /**
381
+ * @public
382
+ */
383
+ export interface CreateEvaluationJobResponse {
384
+ /**
385
+ * <p>The ARN of the model evaluation job.</p>
386
+ * @public
387
+ */
388
+ jobArn: string | undefined;
389
+ }
390
+ /**
391
+ * <p>An internal server error occurred. Retry your request.</p>
392
+ * @public
393
+ */
394
+ export declare class InternalServerException extends __BaseException {
395
+ readonly name: "InternalServerException";
396
+ readonly $fault: "server";
397
+ /**
398
+ * @internal
399
+ */
400
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
401
+ }
402
+ /**
403
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
404
+ * @public
405
+ */
406
+ export declare class ResourceNotFoundException extends __BaseException {
407
+ readonly name: "ResourceNotFoundException";
408
+ readonly $fault: "client";
409
+ /**
410
+ * @internal
411
+ */
412
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
413
+ }
414
+ /**
415
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
416
+ * @public
417
+ */
418
+ export declare class ServiceQuotaExceededException extends __BaseException {
419
+ readonly name: "ServiceQuotaExceededException";
420
+ readonly $fault: "client";
421
+ /**
422
+ * @internal
423
+ */
424
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
425
+ }
426
+ /**
427
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
428
+ * @public
429
+ */
430
+ export declare class ThrottlingException extends __BaseException {
431
+ readonly name: "ThrottlingException";
432
+ readonly $fault: "client";
433
+ /**
434
+ * @internal
435
+ */
436
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
437
+ }
438
+ /**
439
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
440
+ * @public
441
+ */
442
+ export declare class ValidationException extends __BaseException {
443
+ readonly name: "ValidationException";
444
+ readonly $fault: "client";
445
+ /**
446
+ * @internal
447
+ */
448
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
449
+ }
450
+ /**
451
+ * @public
452
+ */
453
+ export interface GetEvaluationJobRequest {
454
+ /**
455
+ * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
456
+ * @public
457
+ */
458
+ jobIdentifier: string | undefined;
459
+ }
460
+ /**
461
+ * @public
462
+ * @enum
463
+ */
464
+ export declare const EvaluationJobType: {
465
+ readonly AUTOMATED: "Automated";
466
+ readonly HUMAN: "Human";
467
+ };
468
+ /**
469
+ * @public
470
+ */
471
+ export type EvaluationJobType = (typeof EvaluationJobType)[keyof typeof EvaluationJobType];
472
+ /**
473
+ * @public
474
+ * @enum
475
+ */
476
+ export declare const EvaluationJobStatus: {
477
+ readonly COMPLETED: "Completed";
478
+ readonly FAILED: "Failed";
479
+ readonly IN_PROGRESS: "InProgress";
480
+ readonly STOPPED: "Stopped";
481
+ readonly STOPPING: "Stopping";
482
+ };
483
+ /**
484
+ * @public
485
+ */
486
+ export type EvaluationJobStatus = (typeof EvaluationJobStatus)[keyof typeof EvaluationJobStatus];
487
+ /**
488
+ * @public
489
+ */
490
+ export interface GetEvaluationJobResponse {
491
+ /**
492
+ * <p>The name of the model evaluation job.</p>
493
+ * @public
494
+ */
495
+ jobName: string | undefined;
496
+ /**
497
+ * <p>The status of the model evaluation job.</p>
498
+ * @public
499
+ */
500
+ status: EvaluationJobStatus | undefined;
501
+ /**
502
+ * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
503
+ * @public
504
+ */
505
+ jobArn: string | undefined;
506
+ /**
507
+ * <p>The description of the model evaluation job.</p>
508
+ * @public
509
+ */
510
+ jobDescription?: string;
511
+ /**
512
+ * <p>The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.</p>
513
+ * @public
514
+ */
515
+ roleArn: string | undefined;
516
+ /**
517
+ * <p>The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.</p>
518
+ * @public
519
+ */
520
+ customerEncryptionKeyId?: string;
521
+ /**
522
+ * <p>The type of model evaluation job.</p>
523
+ * @public
524
+ */
525
+ jobType: EvaluationJobType | undefined;
526
+ /**
527
+ * <p>Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.</p>
528
+ * @public
529
+ */
530
+ evaluationConfig: EvaluationConfig | undefined;
531
+ /**
532
+ * <p>Details about the models you specified in your model evaluation job.</p>
533
+ * @public
534
+ */
535
+ inferenceConfig: EvaluationInferenceConfig | undefined;
536
+ /**
537
+ * <p>Amazon S3 location for where output data is saved.</p>
538
+ * @public
539
+ */
540
+ outputDataConfig: EvaluationOutputDataConfig | undefined;
541
+ /**
542
+ * <p>When the model evaluation job was created.</p>
543
+ * @public
544
+ */
545
+ creationTime: Date | undefined;
546
+ /**
547
+ * <p>When the model evaluation job was last modified.</p>
548
+ * @public
549
+ */
550
+ lastModifiedTime?: Date;
551
+ /**
552
+ * <p>An array of strings the specify why the model evaluation job has failed.</p>
553
+ * @public
554
+ */
555
+ failureMessages?: string[];
556
+ }
557
+ /**
558
+ * @public
559
+ * @enum
560
+ */
561
+ export declare const SortJobsBy: {
562
+ readonly CREATION_TIME: "CreationTime";
563
+ };
564
+ /**
565
+ * @public
566
+ */
567
+ export type SortJobsBy = (typeof SortJobsBy)[keyof typeof SortJobsBy];
568
+ /**
569
+ * @public
570
+ * @enum
571
+ */
572
+ export declare const SortOrder: {
573
+ readonly ASCENDING: "Ascending";
574
+ readonly DESCENDING: "Descending";
575
+ };
576
+ /**
577
+ * @public
578
+ */
579
+ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
580
+ /**
581
+ * @public
582
+ */
583
+ export interface ListEvaluationJobsRequest {
584
+ /**
585
+ * <p>A filter that includes model evaluation jobs created after the time specified.</p>
586
+ * @public
587
+ */
588
+ creationTimeAfter?: Date;
589
+ /**
590
+ * <p>A filter that includes model evaluation jobs created prior to the time specified.</p>
591
+ * @public
592
+ */
593
+ creationTimeBefore?: Date;
594
+ /**
595
+ * <p>Only return jobs where the status condition is met.</p>
596
+ * @public
597
+ */
598
+ statusEquals?: EvaluationJobStatus;
599
+ /**
600
+ * <p>Query parameter string for model evaluation job names.</p>
601
+ * @public
602
+ */
603
+ nameContains?: string;
604
+ /**
605
+ * <p>The maximum number of results to return.</p>
606
+ * @public
607
+ */
608
+ maxResults?: number;
609
+ /**
610
+ * <p>Continuation token from the previous response, for Amazon Bedrock to list the next set of results.</p>
611
+ * @public
612
+ */
613
+ nextToken?: string;
614
+ /**
615
+ * <p>Allows you to sort model evaluation jobs by when they were created.</p>
616
+ * @public
617
+ */
618
+ sortBy?: SortJobsBy;
619
+ /**
620
+ * <p>How you want the order of jobs sorted.</p>
621
+ * @public
622
+ */
623
+ sortOrder?: SortOrder;
624
+ }
625
+ /**
626
+ * <p>A summary of the model evaluation job.</p>
627
+ * @public
628
+ */
629
+ export interface EvaluationSummary {
630
+ /**
631
+ * <p>The Amazon Resource Name (ARN) of the model evaluation job.</p>
632
+ * @public
633
+ */
634
+ jobArn: string | undefined;
635
+ /**
636
+ * <p>The name of the model evaluation job.</p>
637
+ * @public
638
+ */
639
+ jobName: string | undefined;
640
+ /**
641
+ * <p>The current status of the model evaluation job. </p>
642
+ * @public
643
+ */
644
+ status: EvaluationJobStatus | undefined;
645
+ /**
646
+ * <p>When the model evaluation job was created.</p>
647
+ * @public
648
+ */
649
+ creationTime: Date | undefined;
650
+ /**
651
+ * <p>The type, either human or automatic, of model evaluation job.</p>
652
+ * @public
653
+ */
654
+ jobType: EvaluationJobType | undefined;
655
+ /**
656
+ * <p>What task type was used in the model evaluation job.</p>
657
+ * @public
658
+ */
659
+ evaluationTaskTypes: EvaluationTaskType[] | undefined;
660
+ /**
661
+ * <p>The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.</p>
662
+ * @public
663
+ */
664
+ modelIdentifiers: string[] | undefined;
665
+ }
666
+ /**
667
+ * @public
668
+ */
669
+ export interface ListEvaluationJobsResponse {
670
+ /**
671
+ * <p>Continuation token from the previous response, for Amazon Bedrock to list the next set of results.</p>
672
+ * @public
673
+ */
674
+ nextToken?: string;
675
+ /**
676
+ * <p>A summary of the model evaluation jobs.</p>
677
+ * @public
678
+ */
679
+ jobSummaries?: EvaluationSummary[];
680
+ }
681
+ /**
682
+ * @public
683
+ */
684
+ export interface StopEvaluationJobRequest {
685
+ /**
686
+ * <p>The ARN of the model evaluation job you want to stop.</p>
687
+ * @public
688
+ */
689
+ jobIdentifier: string | undefined;
690
+ }
691
+ /**
692
+ * @public
693
+ */
694
+ export interface StopEvaluationJobResponse {
695
+ }
696
+ /**
697
+ * @public
698
+ * @enum
699
+ */
700
+ export declare const GuardrailFilterStrength: {
701
+ readonly HIGH: "HIGH";
702
+ readonly LOW: "LOW";
703
+ readonly MEDIUM: "MEDIUM";
704
+ readonly NONE: "NONE";
705
+ };
706
+ /**
707
+ * @public
708
+ */
709
+ export type GuardrailFilterStrength = (typeof GuardrailFilterStrength)[keyof typeof GuardrailFilterStrength];
710
+ /**
711
+ * @public
712
+ * @enum
713
+ */
714
+ export declare const GuardrailContentFilterType: {
715
+ readonly HATE: "HATE";
716
+ readonly INSULTS: "INSULTS";
717
+ readonly MISCONDUCT: "MISCONDUCT";
718
+ readonly PROMPT_ATTACK: "PROMPT_ATTACK";
719
+ readonly SEXUAL: "SEXUAL";
720
+ readonly VIOLENCE: "VIOLENCE";
721
+ };
722
+ /**
723
+ * @public
724
+ */
725
+ export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
726
+ /**
727
+ * <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p>
728
+ * <ul>
729
+ * <li>
730
+ * <p>
731
+ * <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p>
732
+ * </li>
733
+ * <li>
734
+ * <p>
735
+ * <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p>
736
+ * </li>
737
+ * <li>
738
+ * <p>
739
+ * <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p>
740
+ * </li>
741
+ * <li>
742
+ * <p>
743
+ * <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p>
744
+ * </li>
745
+ * </ul>
746
+ * <p>Content filtering depends on the confidence classification of user inputs and FM
747
+ * responses across each of the four harmful categories. All input and output statements are
748
+ * classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each
749
+ * harmful category. For example, if a statement is classified as
750
+ * <i>Hate</i> with HIGH confidence, the likelihood of the statement
751
+ * representing hateful content is high. A single statement can be classified across
752
+ * multiple categories with varying confidence levels. For example, a single statement
753
+ * can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p>
754
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p>
755
+ * <p>This data type is used in the following API operations:</p>
756
+ * <ul>
757
+ * <li>
758
+ * <p>
759
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax">CreateGuardrail request body</a>
760
+ * </p>
761
+ * </li>
762
+ * <li>
763
+ * <p>
764
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax">UpdateGuardrail request body</a>
765
+ * </p>
766
+ * </li>
767
+ * </ul>
768
+ * @public
769
+ */
770
+ export interface GuardrailContentFilterConfig {
771
+ /**
772
+ * <p>The harmful category that the content filter is applied to.</p>
773
+ * @public
774
+ */
775
+ type: GuardrailContentFilterType | undefined;
776
+ /**
777
+ * <p>The strength of the content filter to apply to prompts. As you
778
+ * increase the filter strength, the likelihood of filtering harmful content increases
779
+ * and the probability of seeing harmful content in your application reduces.</p>
780
+ * @public
781
+ */
782
+ inputStrength: GuardrailFilterStrength | undefined;
783
+ /**
784
+ * <p>The strength of the content filter to apply to model responses. As you
785
+ * increase the filter strength, the likelihood of filtering harmful content increases
786
+ * and the probability of seeing harmful content in your application reduces.</p>
787
+ * @public
788
+ */
789
+ outputStrength: GuardrailFilterStrength | undefined;
790
+ }
791
+ /**
792
+ * <p>Contains details about how to handle harmful content.</p>
793
+ * <p>This data type is used in the following API operations:</p>
794
+ * <ul>
795
+ * <li>
796
+ * <p>
797
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax">CreateGuardrail request body</a>
798
+ * </p>
799
+ * </li>
800
+ * <li>
801
+ * <p>
802
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax">UpdateGuardrail request body</a>
803
+ * </p>
804
+ * </li>
805
+ * </ul>
806
+ * @public
807
+ */
808
+ export interface GuardrailContentPolicyConfig {
809
+ /**
810
+ * <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
811
+ * @public
812
+ */
813
+ filtersConfig: GuardrailContentFilterConfig[] | undefined;
814
+ }
815
+ /**
816
+ * @public
817
+ * @enum
818
+ */
819
+ export declare const GuardrailSensitiveInformationAction: {
820
+ readonly ANONYMIZE: "ANONYMIZE";
821
+ readonly BLOCK: "BLOCK";
822
+ };
823
+ /**
824
+ * @public
825
+ */
826
+ export type GuardrailSensitiveInformationAction = (typeof GuardrailSensitiveInformationAction)[keyof typeof GuardrailSensitiveInformationAction];
827
+ /**
828
+ * @public
829
+ * @enum
830
+ */
831
+ export declare const GuardrailPiiEntityType: {
832
+ readonly ADDRESS: "ADDRESS";
833
+ readonly AGE: "AGE";
834
+ readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
835
+ readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
836
+ readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
837
+ readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
838
+ readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
839
+ readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
840
+ readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
841
+ readonly DRIVER_ID: "DRIVER_ID";
842
+ readonly EMAIL: "EMAIL";
843
+ readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
844
+ readonly IP_ADDRESS: "IP_ADDRESS";
845
+ readonly LICENSE_PLATE: "LICENSE_PLATE";
846
+ readonly MAC_ADDRESS: "MAC_ADDRESS";
847
+ readonly NAME: "NAME";
848
+ readonly PASSWORD: "PASSWORD";
849
+ readonly PHONE: "PHONE";
850
+ readonly PIN: "PIN";
851
+ readonly SWIFT_CODE: "SWIFT_CODE";
852
+ readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
853
+ readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
854
+ readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
855
+ readonly URL: "URL";
856
+ readonly USERNAME: "USERNAME";
857
+ readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
858
+ readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
859
+ readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
860
+ readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
861
+ readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
862
+ readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
863
+ };
864
+ /**
865
+ * @public
866
+ */
867
+ export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
868
+ /**
869
+ * <p>The PII entity to configure for the guardrail.</p>
870
+ * @public
871
+ */
872
+ export interface GuardrailPiiEntityConfig {
873
+ /**
874
+ * <p>Configure guardrail type when the PII entity is detected.</p>
875
+ * @public
876
+ */
877
+ type: GuardrailPiiEntityType | undefined;
878
+ /**
879
+ * <p>Configure guardrail action when the PII entity is detected.</p>
880
+ * @public
881
+ */
882
+ action: GuardrailSensitiveInformationAction | undefined;
883
+ }
884
+ /**
885
+ * <p>The regular expression to configure for the guardrail.</p>
886
+ * @public
887
+ */
888
+ export interface GuardrailRegexConfig {
889
+ /**
890
+ * <p>The name of the regular expression to configure for the guardrail.</p>
891
+ * @public
892
+ */
893
+ name: string | undefined;
894
+ /**
895
+ * <p>The description of the regular expression to configure for the guardrail.</p>
896
+ * @public
897
+ */
898
+ description?: string;
899
+ /**
900
+ * <p>The regular expression pattern to configure for the guardrail.</p>
901
+ * @public
902
+ */
903
+ pattern: string | undefined;
904
+ /**
905
+ * <p>The guardrail action to configure when matching regular expression is detected.</p>
906
+ * @public
907
+ */
908
+ action: GuardrailSensitiveInformationAction | undefined;
909
+ }
910
+ /**
911
+ * <p>Contains details about PII entities and regular expressions to configure for the guardrail.</p>
912
+ * @public
913
+ */
914
+ export interface GuardrailSensitiveInformationPolicyConfig {
915
+ /**
916
+ * <p>A list of PII entities to configure to the guardrail.</p>
917
+ * @public
918
+ */
919
+ piiEntitiesConfig?: GuardrailPiiEntityConfig[];
920
+ /**
921
+ * <p>A list of regular expressions to configure to the guardrail.</p>
922
+ * @public
923
+ */
924
+ regexesConfig?: GuardrailRegexConfig[];
925
+ }
926
+ /**
927
+ * @public
928
+ * @enum
929
+ */
930
+ export declare const GuardrailTopicType: {
931
+ readonly DENY: "DENY";
932
+ };
933
+ /**
934
+ * @public
935
+ */
936
+ export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
937
+ /**
938
+ * <p>Details about topics for the guardrail to identify and deny.</p>
939
+ * <p>This data type is used in the following API operations:</p>
940
+ * <ul>
941
+ * <li>
942
+ * <p>
943
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax">CreateGuardrail request body</a>
944
+ * </p>
945
+ * </li>
946
+ * <li>
947
+ * <p>
948
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax">UpdateGuardrail request body</a>
949
+ * </p>
950
+ * </li>
951
+ * </ul>
952
+ * @public
953
+ */
954
+ export interface GuardrailTopicConfig {
955
+ /**
956
+ * <p>The name of the topic to deny.</p>
957
+ * @public
958
+ */
959
+ name: string | undefined;
960
+ /**
961
+ * <p>A definition of the topic to deny.</p>
962
+ * @public
963
+ */
964
+ definition: string | undefined;
965
+ /**
966
+ * <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
967
+ * @public
968
+ */
969
+ examples?: string[];
970
+ /**
971
+ * <p>Specifies to deny the topic.</p>
972
+ * @public
973
+ */
974
+ type: GuardrailTopicType | undefined;
975
+ }
976
+ /**
977
+ * <p>Contains details about topics that the guardrail should identify and deny.</p>
978
+ * <p>This data type is used in the following API operations:</p>
979
+ * <ul>
980
+ * <li>
981
+ * <p>
982
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax">CreateGuardrail request body</a>
983
+ * </p>
984
+ * </li>
985
+ * <li>
986
+ * <p>
987
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax">UpdateGuardrail request body</a>
988
+ * </p>
989
+ * </li>
990
+ * </ul>
991
+ * @public
992
+ */
993
+ export interface GuardrailTopicPolicyConfig {
994
+ /**
995
+ * <p>A list of policies related to topics that the guardrail should deny.</p>
996
+ * @public
997
+ */
998
+ topicsConfig: GuardrailTopicConfig[] | undefined;
999
+ }
1000
+ /**
1001
+ * @public
1002
+ * @enum
1003
+ */
1004
+ export declare const GuardrailManagedWordsType: {
1005
+ readonly PROFANITY: "PROFANITY";
1006
+ };
1007
+ /**
1008
+ * @public
1009
+ */
1010
+ export type GuardrailManagedWordsType = (typeof GuardrailManagedWordsType)[keyof typeof GuardrailManagedWordsType];
1011
+ /**
1012
+ * <p>The managed word list to configure for the guardrail.</p>
1013
+ * @public
1014
+ */
1015
+ export interface GuardrailManagedWordsConfig {
1016
+ /**
1017
+ * <p>The managed word type to configure for the guardrail.</p>
1018
+ * @public
1019
+ */
1020
+ type: GuardrailManagedWordsType | undefined;
1021
+ }
1022
+ /**
1023
+ * <p>A word to configure for the guardrail.</p>
1024
+ * @public
1025
+ */
1026
+ export interface GuardrailWordConfig {
1027
+ /**
1028
+ * <p>Text of the word configured for the guardrail to block.</p>
1029
+ * @public
1030
+ */
1031
+ text: string | undefined;
1032
+ }
1033
+ /**
1034
+ * <p>Contains details about the word policy to configured for the guardrail.</p>
1035
+ * @public
1036
+ */
1037
+ export interface GuardrailWordPolicyConfig {
1038
+ /**
1039
+ * <p>A list of words to configure for the guardrail.</p>
1040
+ * @public
1041
+ */
1042
+ wordsConfig?: GuardrailWordConfig[];
1043
+ /**
1044
+ * <p>A list of managed words to configure for the guardrail.</p>
1045
+ * @public
1046
+ */
1047
+ managedWordListsConfig?: GuardrailManagedWordsConfig[];
1048
+ }
1049
+ /**
1050
+ * @public
1051
+ */
1052
+ export interface CreateGuardrailRequest {
1053
+ /**
1054
+ * <p>The name to give the guardrail.</p>
1055
+ * @public
1056
+ */
1057
+ name: string | undefined;
1058
+ /**
1059
+ * <p>A description of the guardrail.</p>
1060
+ * @public
1061
+ */
1062
+ description?: string;
1063
+ /**
1064
+ * <p>The topic policies to configure for the guardrail.</p>
1065
+ * @public
1066
+ */
1067
+ topicPolicyConfig?: GuardrailTopicPolicyConfig;
1068
+ /**
1069
+ * <p>The content filter policies to configure for the guardrail.</p>
1070
+ * @public
1071
+ */
1072
+ contentPolicyConfig?: GuardrailContentPolicyConfig;
1073
+ /**
1074
+ * <p>The word policy you configure for the guardrail.</p>
1075
+ * @public
1076
+ */
1077
+ wordPolicyConfig?: GuardrailWordPolicyConfig;
1078
+ /**
1079
+ * <p>The sensitive information policy to configure for the guardrail.</p>
1080
+ * @public
1081
+ */
1082
+ sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig;
1083
+ /**
1084
+ * <p>The message to return when the guardrail blocks a prompt.</p>
1085
+ * @public
1086
+ */
1087
+ blockedInputMessaging: string | undefined;
1088
+ /**
1089
+ * <p>The message to return when the guardrail blocks a model response.</p>
1090
+ * @public
1091
+ */
1092
+ blockedOutputsMessaging: string | undefined;
1093
+ /**
1094
+ * <p>The ARN of the KMS key that you use to encrypt the guardrail.</p>
1095
+ * @public
1096
+ */
1097
+ kmsKeyId?: string;
1098
+ /**
1099
+ * <p>The tags that you want to attach to the guardrail. </p>
1100
+ * @public
1101
+ */
1102
+ tags?: Tag[];
1103
+ /**
1104
+ * <p>A unique, case-sensitive identifier to ensure that the API request
1105
+ * completes no more than once. If this token matches a previous request,
1106
+ * Amazon Bedrock ignores the request, but does not return an error.
1107
+ * For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
1108
+ * idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
1109
+ * @public
1110
+ */
1111
+ clientRequestToken?: string;
1112
+ }
1113
+ /**
1114
+ * @public
1115
+ */
1116
+ export interface CreateGuardrailResponse {
1117
+ /**
1118
+ * <p>The unique identifier of the guardrail that was created.</p>
1119
+ * @public
1120
+ */
1121
+ guardrailId: string | undefined;
1122
+ /**
1123
+ * <p>The ARN of the guardrail that was created.</p>
1124
+ * @public
1125
+ */
1126
+ guardrailArn: string | undefined;
1127
+ /**
1128
+ * <p>The version of the guardrail that was created. This value should be 1.</p>
1129
+ * @public
1130
+ */
1131
+ version: string | undefined;
1132
+ /**
1133
+ * <p>The time at which the guardrail was created.</p>
1134
+ * @public
1135
+ */
1136
+ createdAt: Date | undefined;
1137
+ }
1138
+ /**
1139
+ * <p>The request contains more tags than can be associated with a resource (50 tags per resource).
1140
+ * The maximum number of tags includes both existing tags and those included in your current request. </p>
1141
+ * @public
1142
+ */
1143
+ export declare class TooManyTagsException extends __BaseException {
1144
+ readonly name: "TooManyTagsException";
1145
+ readonly $fault: "client";
1146
+ /**
1147
+ * <p>The name of the resource with too many tags.</p>
1148
+ * @public
1149
+ */
1150
+ resourceName?: string;
1151
+ /**
1152
+ * @internal
1153
+ */
1154
+ constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
1155
+ }
1156
+ /**
1157
+ * @public
1158
+ */
1159
+ export interface CreateGuardrailVersionRequest {
1160
+ /**
1161
+ * <p>The unique identifier of the guardrail.</p>
1162
+ * @public
1163
+ */
1164
+ guardrailIdentifier: string | undefined;
1165
+ /**
1166
+ * <p>A description of the guardrail version.</p>
1167
+ * @public
1168
+ */
1169
+ description?: string;
1170
+ /**
1171
+ * <p>A unique, case-sensitive identifier to ensure that the API request
1172
+ * completes no more than once. If this token matches a previous request,
1173
+ * Amazon Bedrock ignores the request, but does not return an error.
1174
+ * For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring
1175
+ * idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
1176
+ * @public
1177
+ */
1178
+ clientRequestToken?: string;
1179
+ }
1180
+ /**
1181
+ * @public
1182
+ */
1183
+ export interface CreateGuardrailVersionResponse {
1184
+ /**
1185
+ * <p>The unique identifier of the guardrail.</p>
1186
+ * @public
1187
+ */
1188
+ guardrailId: string | undefined;
1189
+ /**
1190
+ * <p>The number of the version of the guardrail.</p>
1191
+ * @public
1192
+ */
1193
+ version: string | undefined;
1194
+ }
1195
+ /**
1196
+ * @public
1197
+ */
1198
+ export interface DeleteGuardrailRequest {
1199
+ /**
1200
+ * <p>The unique identifier of the guardrail.</p>
1201
+ * @public
1202
+ */
1203
+ guardrailIdentifier: string | undefined;
1204
+ /**
1205
+ * <p>The version of the guardrail.</p>
1206
+ * @public
1207
+ */
1208
+ guardrailVersion?: string;
1209
+ }
1210
+ /**
1211
+ * @public
1212
+ */
1213
+ export interface DeleteGuardrailResponse {
1214
+ }
1215
+ /**
1216
+ * @public
1217
+ */
1218
+ export interface GetGuardrailRequest {
1219
+ /**
1220
+ * <p>The unique identifier of the guardrail for which to get details.</p>
1221
+ * @public
1222
+ */
1223
+ guardrailIdentifier: string | undefined;
1224
+ /**
1225
+ * <p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>
1226
+ * @public
1227
+ */
1228
+ guardrailVersion?: string;
1229
+ }
1230
+ /**
1231
+ * <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p>
1232
+ * <ul>
1233
+ * <li>
1234
+ * <p>
1235
+ * <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p>
1236
+ * </li>
1237
+ * <li>
1238
+ * <p>
1239
+ * <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p>
1240
+ * </li>
1241
+ * <li>
1242
+ * <p>
1243
+ * <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p>
1244
+ * </li>
1245
+ * <li>
1246
+ * <p>
1247
+ * <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p>
1248
+ * </li>
1249
+ * </ul>
1250
+ * <p>Content filtering depends on the confidence classification of user inputs and FM
1251
+ * responses across each of the four harmful categories. All input and output statements are
1252
+ * classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each
1253
+ * harmful category. For example, if a statement is classified as
1254
+ * <i>Hate</i> with HIGH confidence, the likelihood of the statement
1255
+ * representing hateful content is high. A single statement can be classified across
1256
+ * multiple categories with varying confidence levels. For example, a single statement
1257
+ * can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p>
1258
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p>
1259
+ * <p>This data type is used in the following API operations:</p>
1260
+ * <ul>
1261
+ * <li>
1262
+ * <p>
1263
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a>
1264
+ * </p>
1265
+ * </li>
1266
+ * </ul>
1267
+ * @public
1268
+ */
1269
+ export interface GuardrailContentFilter {
1270
+ /**
1271
+ * <p>The harmful category that the content filter is applied to.</p>
1272
+ * @public
1273
+ */
1274
+ type: GuardrailContentFilterType | undefined;
1275
+ /**
1276
+ * <p>The strength of the content filter to apply to prompts. As you
1277
+ * increase the filter strength, the likelihood of filtering harmful content increases
1278
+ * and the probability of seeing harmful content in your application reduces.</p>
1279
+ * @public
1280
+ */
1281
+ inputStrength: GuardrailFilterStrength | undefined;
1282
+ /**
1283
+ * <p>The strength of the content filter to apply to model responses. As you
1284
+ * increase the filter strength, the likelihood of filtering harmful content increases
1285
+ * and the probability of seeing harmful content in your application reduces.</p>
1286
+ * @public
1287
+ */
1288
+ outputStrength: GuardrailFilterStrength | undefined;
1289
+ }
1290
+ /**
1291
+ * <p>Contains details about how to handle harmful content.</p>
1292
+ * <p>This data type is used in the following API operations:</p>
1293
+ * <ul>
1294
+ * <li>
1295
+ * <p>
1296
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a>
1297
+ * </p>
1298
+ * </li>
1299
+ * </ul>
1300
+ * @public
1301
+ */
1302
+ export interface GuardrailContentPolicy {
1303
+ /**
1304
+ * <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
1305
+ * @public
1306
+ */
1307
+ filters?: GuardrailContentFilter[];
1308
+ }
1309
+ /**
1310
+ * <p>The PII entity configured for the guardrail.</p>
1311
+ * @public
1312
+ */
1313
+ export interface GuardrailPiiEntity {
1314
+ /**
1315
+ * <p>The type of PII entity. For example, Social Security Number.</p>
1316
+ * @public
1317
+ */
1318
+ type: GuardrailPiiEntityType | undefined;
1319
+ /**
1320
+ * <p>The configured guardrail action when PII entity is detected.</p>
1321
+ * @public
1322
+ */
1323
+ action: GuardrailSensitiveInformationAction | undefined;
1324
+ }
1325
+ /**
1326
+ * <p>The regular expression configured for the guardrail.</p>
1327
+ * @public
1328
+ */
1329
+ export interface GuardrailRegex {
1330
+ /**
1331
+ * <p>The name of the regular expression for the guardrail.</p>
1332
+ * @public
1333
+ */
1334
+ name: string | undefined;
1335
+ /**
1336
+ * <p>The description of the regular expression for the guardrail.</p>
1337
+ * @public
1338
+ */
1339
+ description?: string;
1340
+ /**
1341
+ * <p>The pattern of the regular expression configured for the guardrail.</p>
1342
+ * @public
1343
+ */
1344
+ pattern: string | undefined;
1345
+ /**
1346
+ * <p>The action taken when a match to the regular expression is detected.</p>
1347
+ * @public
1348
+ */
1349
+ action: GuardrailSensitiveInformationAction | undefined;
1350
+ }
1351
+ /**
1352
+ * <p>Contains details about PII entities and regular expressions configured for the guardrail.</p>
1353
+ * @public
1354
+ */
1355
+ export interface GuardrailSensitiveInformationPolicy {
1356
+ /**
1357
+ * <p>The list of PII entities configured for the guardrail.</p>
1358
+ * @public
1359
+ */
1360
+ piiEntities?: GuardrailPiiEntity[];
1361
+ /**
1362
+ * <p>The list of regular expressions configured for the guardrail.</p>
1363
+ * @public
1364
+ */
1365
+ regexes?: GuardrailRegex[];
1366
+ }
1367
+ /**
1368
+ * @public
1369
+ * @enum
1370
+ */
1371
+ export declare const GuardrailStatus: {
1372
+ readonly CREATING: "CREATING";
1373
+ readonly DELETING: "DELETING";
1374
+ readonly FAILED: "FAILED";
1375
+ readonly READY: "READY";
1376
+ readonly UPDATING: "UPDATING";
1377
+ readonly VERSIONING: "VERSIONING";
1378
+ };
1379
+ /**
1380
+ * @public
1381
+ */
1382
+ export type GuardrailStatus = (typeof GuardrailStatus)[keyof typeof GuardrailStatus];
1383
+ /**
1384
+ * <p>Details about topics for the guardrail to identify and deny.</p>
1385
+ * <p>This data type is used in the following API operations:</p>
1386
+ * <ul>
1387
+ * <li>
1388
+ * <p>
1389
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a>
1390
+ * </p>
1391
+ * </li>
1392
+ * </ul>
1393
+ * @public
1394
+ */
1395
+ export interface GuardrailTopic {
1396
+ /**
1397
+ * <p>The name of the topic to deny.</p>
1398
+ * @public
1399
+ */
1400
+ name: string | undefined;
1401
+ /**
1402
+ * <p>A definition of the topic to deny.</p>
1403
+ * @public
1404
+ */
1405
+ definition: string | undefined;
1406
+ /**
1407
+ * <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
1408
+ * @public
1409
+ */
1410
+ examples?: string[];
1411
+ /**
1412
+ * <p>Specifies to deny the topic.</p>
1413
+ * @public
1414
+ */
1415
+ type?: GuardrailTopicType;
1416
+ }
1417
+ /**
1418
+ * <p>Contains details about topics that the guardrail should identify and deny.</p>
1419
+ * <p>This data type is used in the following API operations:</p>
1420
+ * <ul>
1421
+ * <li>
1422
+ * <p>
1423
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a>
1424
+ * </p>
1425
+ * </li>
1426
+ * </ul>
1427
+ * @public
1428
+ */
1429
+ export interface GuardrailTopicPolicy {
1430
+ /**
1431
+ * <p>A list of policies related to topics that the guardrail should deny.</p>
1432
+ * @public
1433
+ */
1434
+ topics: GuardrailTopic[] | undefined;
1435
+ }
1436
+ /**
1437
+ * <p>The managed word list that was configured for the guardrail.
1438
+ * (This is a list of words that are pre-defined and managed by Guardrails only.)</p>
1439
+ * @public
1440
+ */
1441
+ export interface GuardrailManagedWords {
1442
+ /**
1443
+ * <p>ManagedWords$type
1444
+ * The managed word type that was configured for the guardrail.
1445
+ * (For now, we only offer profanity word list)</p>
1446
+ * @public
1447
+ */
1448
+ type: GuardrailManagedWordsType | undefined;
1449
+ }
1450
+ /**
1451
+ * <p>A word configured for the guardrail.</p>
1452
+ * @public
1453
+ */
1454
+ export interface GuardrailWord {
1455
+ /**
1456
+ * <p>Text of the word configured for the guardrail to block.</p>
1457
+ * @public
1458
+ */
1459
+ text: string | undefined;
1460
+ }
1461
+ /**
1462
+ * <p>Contains details about the word policy configured for the guardrail.</p>
1463
+ * @public
1464
+ */
1465
+ export interface GuardrailWordPolicy {
1466
+ /**
1467
+ * <p>A list of words configured for the guardrail.</p>
1468
+ * @public
1469
+ */
1470
+ words?: GuardrailWord[];
1471
+ /**
1472
+ * <p>A list of managed words configured for the guardrail.</p>
1473
+ * @public
1474
+ */
1475
+ managedWordLists?: GuardrailManagedWords[];
1476
+ }
1477
+ /**
1478
+ * @public
1479
+ */
1480
+ export interface GetGuardrailResponse {
1481
+ /**
1482
+ * <p>The name of the guardrail.</p>
1483
+ * @public
1484
+ */
1485
+ name: string | undefined;
1486
+ /**
1487
+ * <p>The description of the guardrail.</p>
1488
+ * @public
1489
+ */
1490
+ description?: string;
1491
+ /**
1492
+ * <p>The unique identifier of the guardrail.</p>
1493
+ * @public
1494
+ */
1495
+ guardrailId: string | undefined;
1496
+ /**
1497
+ * <p>The ARN of the guardrail that was created.</p>
1498
+ * @public
1499
+ */
1500
+ guardrailArn: string | undefined;
1501
+ /**
1502
+ * <p>The version of the guardrail.</p>
1503
+ * @public
1504
+ */
1505
+ version: string | undefined;
1506
+ /**
1507
+ * <p>The status of the guardrail.</p>
1508
+ * @public
1509
+ */
1510
+ status: GuardrailStatus | undefined;
1511
+ /**
1512
+ * <p>The topic policy that was configured for the guardrail.</p>
1513
+ * @public
1514
+ */
1515
+ topicPolicy?: GuardrailTopicPolicy;
1516
+ /**
1517
+ * <p>The content policy that was configured for the guardrail.</p>
1518
+ * @public
1519
+ */
1520
+ contentPolicy?: GuardrailContentPolicy;
1521
+ /**
1522
+ * <p>The word policy that was configured for the guardrail.</p>
1523
+ * @public
1524
+ */
1525
+ wordPolicy?: GuardrailWordPolicy;
1526
+ /**
1527
+ * <p>The sensitive information policy that was configured for the guardrail.</p>
1528
+ * @public
1529
+ */
1530
+ sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy;
1531
+ /**
1532
+ * <p>The date and time at which the guardrail was created.</p>
1533
+ * @public
1534
+ */
1535
+ createdAt: Date | undefined;
1536
+ /**
1537
+ * <p>The date and time at which the guardrail was updated.</p>
1538
+ * @public
1539
+ */
1540
+ updatedAt: Date | undefined;
1541
+ /**
1542
+ * <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
1543
+ * @public
1544
+ */
1545
+ statusReasons?: string[];
1546
+ /**
1547
+ * <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
1548
+ * @public
1549
+ */
1550
+ failureRecommendations?: string[];
1551
+ /**
1552
+ * <p>The message that the guardrail returns when it blocks a prompt.</p>
1553
+ * @public
1554
+ */
1555
+ blockedInputMessaging: string | undefined;
1556
+ /**
1557
+ * <p>The message that the guardrail returns when it blocks a model response.</p>
1558
+ * @public
1559
+ */
1560
+ blockedOutputsMessaging: string | undefined;
1561
+ /**
1562
+ * <p>The ARN of the KMS key that encrypts the guardrail.</p>
1563
+ * @public
1564
+ */
1565
+ kmsKeyArn?: string;
1566
+ }
1567
+ /**
1568
+ * @public
1569
+ */
1570
+ export interface ListGuardrailsRequest {
1571
+ /**
1572
+ * <p>The unique identifier of the guardrail.</p>
1573
+ * @public
1574
+ */
1575
+ guardrailIdentifier?: string;
1576
+ /**
1577
+ * <p>The maximum number of results to return in the response.</p>
1578
+ * @public
1579
+ */
1580
+ maxResults?: number;
1581
+ /**
1582
+ * <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
1583
+ * @public
1584
+ */
1585
+ nextToken?: string;
1586
+ }
1587
+ /**
1588
+ * <p>Contains details about a guardrail.</p>
1589
+ * <p>This data type is used in the following API operations:</p>
1590
+ * <ul>
1591
+ * <li>
1592
+ * <p>
1593
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax">ListGuardrails response body</a>
1594
+ * </p>
1595
+ * </li>
1596
+ * </ul>
16
1597
  * @public
17
1598
  */
18
- export interface DeleteModelInvocationLoggingConfigurationRequest {
1599
+ export interface GuardrailSummary {
1600
+ /**
1601
+ * <p>The unique identifier of the guardrail.</p>
1602
+ * @public
1603
+ */
1604
+ id: string | undefined;
1605
+ /**
1606
+ * <p>The ARN of the guardrail.</p>
1607
+ * @public
1608
+ */
1609
+ arn: string | undefined;
1610
+ /**
1611
+ * <p>The status of the guardrail.</p>
1612
+ * @public
1613
+ */
1614
+ status: GuardrailStatus | undefined;
1615
+ /**
1616
+ * <p>The name of the guardrail.</p>
1617
+ * @public
1618
+ */
1619
+ name: string | undefined;
1620
+ /**
1621
+ * <p>A description of the guardrail.</p>
1622
+ * @public
1623
+ */
1624
+ description?: string;
1625
+ /**
1626
+ * <p>The version of the guardrail.</p>
1627
+ * @public
1628
+ */
1629
+ version: string | undefined;
1630
+ /**
1631
+ * <p>The date and time at which the guardrail was created.</p>
1632
+ * @public
1633
+ */
1634
+ createdAt: Date | undefined;
1635
+ /**
1636
+ * <p>The date and time at which the guardrail was last updated.</p>
1637
+ * @public
1638
+ */
1639
+ updatedAt: Date | undefined;
19
1640
  }
20
1641
  /**
21
1642
  * @public
22
1643
  */
23
- export interface DeleteModelInvocationLoggingConfigurationResponse {
1644
+ export interface ListGuardrailsResponse {
1645
+ /**
1646
+ * <p>A list of objects, each of which contains details about a guardrail.</p>
1647
+ * @public
1648
+ */
1649
+ guardrails: GuardrailSummary[] | undefined;
1650
+ /**
1651
+ * <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
1652
+ * @public
1653
+ */
1654
+ nextToken?: string;
24
1655
  }
25
1656
  /**
26
- * <p>An internal server error occurred. Retry your request.</p>
27
1657
  * @public
28
1658
  */
29
- export declare class InternalServerException extends __BaseException {
30
- readonly name: "InternalServerException";
31
- readonly $fault: "server";
1659
+ export interface UpdateGuardrailRequest {
32
1660
  /**
33
- * @internal
1661
+ * <p>The unique identifier of the guardrail</p>
1662
+ * @public
34
1663
  */
35
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
1664
+ guardrailIdentifier: string | undefined;
1665
+ /**
1666
+ * <p>A name for the guardrail.</p>
1667
+ * @public
1668
+ */
1669
+ name: string | undefined;
1670
+ /**
1671
+ * <p>A description of the guardrail.</p>
1672
+ * @public
1673
+ */
1674
+ description?: string;
1675
+ /**
1676
+ * <p>The topic policy to configure for the guardrail.</p>
1677
+ * @public
1678
+ */
1679
+ topicPolicyConfig?: GuardrailTopicPolicyConfig;
1680
+ /**
1681
+ * <p>The content policy to configure for the guardrail.</p>
1682
+ * @public
1683
+ */
1684
+ contentPolicyConfig?: GuardrailContentPolicyConfig;
1685
+ /**
1686
+ * <p>The word policy to configure for the guardrail.</p>
1687
+ * @public
1688
+ */
1689
+ wordPolicyConfig?: GuardrailWordPolicyConfig;
1690
+ /**
1691
+ * <p>The sensitive information policy to configure for the guardrail.</p>
1692
+ * @public
1693
+ */
1694
+ sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig;
1695
+ /**
1696
+ * <p>The message to return when the guardrail blocks a prompt.</p>
1697
+ * @public
1698
+ */
1699
+ blockedInputMessaging: string | undefined;
1700
+ /**
1701
+ * <p>The message to return when the guardrail blocks a model response.</p>
1702
+ * @public
1703
+ */
1704
+ blockedOutputsMessaging: string | undefined;
1705
+ /**
1706
+ * <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
1707
+ * @public
1708
+ */
1709
+ kmsKeyId?: string;
36
1710
  }
37
1711
  /**
38
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
39
1712
  * @public
40
1713
  */
41
- export declare class ThrottlingException extends __BaseException {
42
- readonly name: "ThrottlingException";
43
- readonly $fault: "client";
1714
+ export interface UpdateGuardrailResponse {
44
1715
  /**
45
- * @internal
1716
+ * <p>The unique identifier of the guardrail</p>
1717
+ * @public
46
1718
  */
47
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1719
+ guardrailId: string | undefined;
1720
+ /**
1721
+ * <p>The ARN of the guardrail that was created.</p>
1722
+ * @public
1723
+ */
1724
+ guardrailArn: string | undefined;
1725
+ /**
1726
+ * <p>The version of the guardrail.</p>
1727
+ * @public
1728
+ */
1729
+ version: string | undefined;
1730
+ /**
1731
+ * <p>The date and time at which the guardrail was updated.</p>
1732
+ * @public
1733
+ */
1734
+ updatedAt: Date | undefined;
1735
+ }
1736
+ /**
1737
+ * @public
1738
+ */
1739
+ export interface DeleteModelInvocationLoggingConfigurationRequest {
1740
+ }
1741
+ /**
1742
+ * @public
1743
+ */
1744
+ export interface DeleteModelInvocationLoggingConfigurationResponse {
48
1745
  }
49
1746
  /**
50
1747
  * @public
@@ -78,7 +1775,7 @@ export interface CloudWatchConfig {
78
1775
  */
79
1776
  logGroupName: string | undefined;
80
1777
  /**
81
- * <p>The role ARN.</p>
1778
+ * <p>The role Amazon Resource Name (ARN).</p>
82
1779
  * @public
83
1780
  */
84
1781
  roleArn: string | undefined;
@@ -89,7 +1786,7 @@ export interface CloudWatchConfig {
89
1786
  largeDataDeliveryS3Config?: S3Config;
90
1787
  }
91
1788
  /**
92
- * <p>Configuration fields for invokation logging.</p>
1789
+ * <p>Configuration fields for invocation logging.</p>
93
1790
  * @public
94
1791
  */
95
1792
  export interface LoggingConfig {
@@ -144,30 +1841,6 @@ export interface PutModelInvocationLoggingConfigurationRequest {
144
1841
  */
145
1842
  export interface PutModelInvocationLoggingConfigurationResponse {
146
1843
  }
147
- /**
148
- * <p>Input validation failed. Check your request parameters and retry the request.</p>
149
- * @public
150
- */
151
- export declare class ValidationException extends __BaseException {
152
- readonly name: "ValidationException";
153
- readonly $fault: "client";
154
- /**
155
- * @internal
156
- */
157
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
158
- }
159
- /**
160
- * <p>Error occurred because of a conflict while performing an operation.</p>
161
- * @public
162
- */
163
- export declare class ConflictException extends __BaseException {
164
- readonly name: "ConflictException";
165
- readonly $fault: "client";
166
- /**
167
- * @internal
168
- */
169
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
170
- }
171
1844
  /**
172
1845
  * @public
173
1846
  */
@@ -183,24 +1856,12 @@ export interface DeleteCustomModelRequest {
183
1856
  */
184
1857
  export interface DeleteCustomModelResponse {
185
1858
  }
186
- /**
187
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
188
- * @public
189
- */
190
- export declare class ResourceNotFoundException extends __BaseException {
191
- readonly name: "ResourceNotFoundException";
192
- readonly $fault: "client";
193
- /**
194
- * @internal
195
- */
196
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
197
- }
198
1859
  /**
199
1860
  * @public
200
1861
  */
201
1862
  export interface GetCustomModelRequest {
202
1863
  /**
203
- * <p>Name or ARN of the custom model.</p>
1864
+ * <p>Name or Amazon Resource Name (ARN) of the custom model.</p>
204
1865
  * @public
205
1866
  */
206
1867
  modelIdentifier: string | undefined;
@@ -288,7 +1949,7 @@ export interface ValidatorMetric {
288
1949
  */
289
1950
  export interface GetCustomModelResponse {
290
1951
  /**
291
- * <p>ARN associated with this model.</p>
1952
+ * <p>Amazon Resource Name (ARN) associated with this model.</p>
292
1953
  * @public
293
1954
  */
294
1955
  modelArn: string | undefined;
@@ -303,12 +1964,12 @@ export interface GetCustomModelResponse {
303
1964
  */
304
1965
  jobName?: string;
305
1966
  /**
306
- * <p>Job ARN associated with this model.</p>
1967
+ * <p>Job Amazon Resource Name (ARN) associated with this model.</p>
307
1968
  * @public
308
1969
  */
309
1970
  jobArn: string | undefined;
310
1971
  /**
311
- * <p>ARN of the base model.</p>
1972
+ * <p>Amazon Resource Name (ARN) of the base model.</p>
312
1973
  * @public
313
1974
  */
314
1975
  baseModelArn: string | undefined;
@@ -323,17 +1984,17 @@ export interface GetCustomModelResponse {
323
1984
  */
324
1985
  modelKmsKeyArn?: string;
325
1986
  /**
326
- * <p>Hyperparameter values associated with this model.</p>
1987
+ * <p>Hyperparameter values associated with this model. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
327
1988
  * @public
328
1989
  */
329
1990
  hyperParameters?: Record<string, string>;
330
1991
  /**
331
- * <p>Information about the training dataset.</p>
1992
+ * <p>Contains information about the training dataset.</p>
332
1993
  * @public
333
1994
  */
334
1995
  trainingDataConfig: TrainingDataConfig | undefined;
335
1996
  /**
336
- * <p>Array of up to 10 validators.</p>
1997
+ * <p>Contains information about the validation dataset.</p>
337
1998
  * @public
338
1999
  */
339
2000
  validationDataConfig?: ValidationDataConfig;
@@ -343,7 +2004,7 @@ export interface GetCustomModelResponse {
343
2004
  */
344
2005
  outputDataConfig: OutputDataConfig | undefined;
345
2006
  /**
346
- * <p>The training metrics from the job creation.</p>
2007
+ * <p>Contains training metrics from the job creation.</p>
347
2008
  * @public
348
2009
  */
349
2010
  trainingMetrics?: TrainingMetrics;
@@ -434,7 +2095,7 @@ export interface FoundationModelLifecycle {
434
2095
  */
435
2096
  export interface FoundationModelDetails {
436
2097
  /**
437
- * <p>The model ARN.</p>
2098
+ * <p>The model Amazon Resource Name (ARN).</p>
438
2099
  * @public
439
2100
  */
440
2101
  modelArn: string | undefined;
@@ -449,7 +2110,7 @@ export interface FoundationModelDetails {
449
2110
  */
450
2111
  modelName?: string;
451
2112
  /**
452
- * <p>he model's provider name.</p>
2113
+ * <p>The model's provider name.</p>
453
2114
  * @public
454
2115
  */
455
2116
  providerName?: string;
@@ -505,18 +2166,6 @@ export declare const SortModelsBy: {
505
2166
  * @public
506
2167
  */
507
2168
  export type SortModelsBy = (typeof SortModelsBy)[keyof typeof SortModelsBy];
508
- /**
509
- * @public
510
- * @enum
511
- */
512
- export declare const SortOrder: {
513
- readonly ASCENDING: "Ascending";
514
- readonly DESCENDING: "Descending";
515
- };
516
- /**
517
- * @public
518
- */
519
- export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
520
2169
  /**
521
2170
  * @public
522
2171
  */
@@ -537,12 +2186,12 @@ export interface ListCustomModelsRequest {
537
2186
  */
538
2187
  nameContains?: string;
539
2188
  /**
540
- * <p>Return custom models only if the base model ARN matches this parameter.</p>
2189
+ * <p>Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.</p>
541
2190
  * @public
542
2191
  */
543
2192
  baseModelArnEquals?: string;
544
2193
  /**
545
- * <p>Return custom models only if the foundation model ARN matches this parameter.</p>
2194
+ * <p>Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.</p>
546
2195
  * @public
547
2196
  */
548
2197
  foundationModelArnEquals?: string;
@@ -573,7 +2222,7 @@ export interface ListCustomModelsRequest {
573
2222
  */
574
2223
  export interface CustomModelSummary {
575
2224
  /**
576
- * <p>The ARN of the custom model.</p>
2225
+ * <p>The Amazon Resource Name (ARN) of the custom model.</p>
577
2226
  * @public
578
2227
  */
579
2228
  modelArn: string | undefined;
@@ -588,7 +2237,7 @@ export interface CustomModelSummary {
588
2237
  */
589
2238
  creationTime: Date | undefined;
590
2239
  /**
591
- * <p>The base model ARN.</p>
2240
+ * <p>The base model Amazon Resource Name (ARN).</p>
592
2241
  * @public
593
2242
  */
594
2243
  baseModelArn: string | undefined;
@@ -623,22 +2272,22 @@ export interface ListCustomModelsResponse {
623
2272
  */
624
2273
  export interface ListFoundationModelsRequest {
625
2274
  /**
626
- * <p>A Amazon Bedrock model provider.</p>
2275
+ * <p>Return models belonging to the model provider that you specify.</p>
627
2276
  * @public
628
2277
  */
629
2278
  byProvider?: string;
630
2279
  /**
631
- * <p>List by customization type.</p>
2280
+ * <p>Return models that support the customization type that you specify. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
632
2281
  * @public
633
2282
  */
634
2283
  byCustomizationType?: ModelCustomization;
635
2284
  /**
636
- * <p>List by output modality type.</p>
2285
+ * <p>Return models that support the output modality that you specify.</p>
637
2286
  * @public
638
2287
  */
639
2288
  byOutputModality?: ModelModality;
640
2289
  /**
641
- * <p>List by inference type.</p>
2290
+ * <p>Return models that support the inference type that you specify. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
642
2291
  * @public
643
2292
  */
644
2293
  byInferenceType?: InferenceType;
@@ -649,12 +2298,12 @@ export interface ListFoundationModelsRequest {
649
2298
  */
650
2299
  export interface FoundationModelSummary {
651
2300
  /**
652
- * <p>The ARN of the foundation model.</p>
2301
+ * <p>The Amazon Resource Name (ARN) of the foundation model.</p>
653
2302
  * @public
654
2303
  */
655
2304
  modelArn: string | undefined;
656
2305
  /**
657
- * <p>The model Id of the foundation model.</p>
2306
+ * <p>The model ID of the foundation model.</p>
658
2307
  * @public
659
2308
  */
660
2309
  modelId: string | undefined;
@@ -721,54 +2370,41 @@ export declare const CommitmentDuration: {
721
2370
  * @public
722
2371
  */
723
2372
  export type CommitmentDuration = (typeof CommitmentDuration)[keyof typeof CommitmentDuration];
724
- /**
725
- * <p>Definition of the key/value pair for a tag.</p>
726
- * @public
727
- */
728
- export interface Tag {
729
- /**
730
- * <p>Key for the tag.</p>
731
- * @public
732
- */
733
- key: string | undefined;
734
- /**
735
- * <p>Value for the tag.</p>
736
- * @public
737
- */
738
- value: string | undefined;
739
- }
740
2373
  /**
741
2374
  * @public
742
2375
  */
743
2376
  export interface CreateProvisionedModelThroughputRequest {
744
2377
  /**
745
- * <p>Unique token value that you can provide. If this token matches a previous request,
746
- * Amazon Bedrock ignores the request, but does not return an error.</p>
2378
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
2379
+ * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the Amazon S3 User Guide.</p>
747
2380
  * @public
748
2381
  */
749
2382
  clientRequestToken?: string;
750
2383
  /**
751
- * <p>Number of model units to allocate.</p>
2384
+ * <p>Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase">Amazon Web Services support center</a> to request MUs.</p>
2385
+ * <p>For model unit quotas, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas">Provisioned Throughput quotas</a> in the Amazon Bedrock User Guide.</p>
2386
+ * <p>For more information about what an MU specifies, contact your Amazon Web Services account manager.</p>
752
2387
  * @public
753
2388
  */
754
2389
  modelUnits: number | undefined;
755
2390
  /**
756
- * <p>Unique name for this provisioned throughput.</p>
2391
+ * <p>The name for this Provisioned Throughput.</p>
757
2392
  * @public
758
2393
  */
759
2394
  provisionedModelName: string | undefined;
760
2395
  /**
761
- * <p>Name or ARN of the model to associate with this provisioned throughput.</p>
2396
+ * <p>The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models">Amazon Bedrock model IDs for purchasing Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
762
2397
  * @public
763
2398
  */
764
2399
  modelId: string | undefined;
765
2400
  /**
766
- * <p>Commitment duration requested for the provisioned throughput.</p>
2401
+ * <p>The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.</p>
2402
+ * <p>Custom models support all levels of commitment. To see which base models support no commitment, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html">Supported regions and models for Provisioned Throughput</a> in the Amazon Bedrock User Guide</p>
767
2403
  * @public
768
2404
  */
769
2405
  commitmentDuration?: CommitmentDuration;
770
2406
  /**
771
- * <p>Tags to associate with this provisioned throughput.</p>
2407
+ * <p>Tags to associate with this Provisioned Throughput.</p>
772
2408
  * @public
773
2409
  */
774
2410
  tags?: Tag[];
@@ -778,47 +2414,17 @@ export interface CreateProvisionedModelThroughputRequest {
778
2414
  */
779
2415
  export interface CreateProvisionedModelThroughputResponse {
780
2416
  /**
781
- * <p>The ARN for this provisioned throughput.</p>
2417
+ * <p>The Amazon Resource Name (ARN) for this Provisioned Throughput.</p>
782
2418
  * @public
783
2419
  */
784
2420
  provisionedModelArn: string | undefined;
785
2421
  }
786
- /**
787
- * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
788
- * @public
789
- */
790
- export declare class ServiceQuotaExceededException extends __BaseException {
791
- readonly name: "ServiceQuotaExceededException";
792
- readonly $fault: "client";
793
- /**
794
- * @internal
795
- */
796
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
797
- }
798
- /**
799
- * <p>The request contains more tags than can be associated with a resource (50 tags per resource).
800
- * The maximum number of tags includes both existing tags and those included in your current request. </p>
801
- * @public
802
- */
803
- export declare class TooManyTagsException extends __BaseException {
804
- readonly name: "TooManyTagsException";
805
- readonly $fault: "client";
806
- /**
807
- * <p>The name of the resource with too many tags.</p>
808
- * @public
809
- */
810
- resourceName?: string;
811
- /**
812
- * @internal
813
- */
814
- constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
815
- }
816
2422
  /**
817
2423
  * @public
818
2424
  */
819
2425
  export interface DeleteProvisionedModelThroughputRequest {
820
2426
  /**
821
- * <p>The ARN or name of the provisioned throughput.</p>
2427
+ * <p>The Amazon Resource Name (ARN) or name of the Provisioned Throughput.</p>
822
2428
  * @public
823
2429
  */
824
2430
  provisionedModelId: string | undefined;
@@ -833,7 +2439,7 @@ export interface DeleteProvisionedModelThroughputResponse {
833
2439
  */
834
2440
  export interface GetProvisionedModelThroughputRequest {
835
2441
  /**
836
- * <p>The ARN or name of the provisioned throughput.</p>
2442
+ * <p>The Amazon Resource Name (ARN) or name of the Provisioned Throughput.</p>
837
2443
  * @public
838
2444
  */
839
2445
  provisionedModelId: string | undefined;
@@ -857,67 +2463,67 @@ export type ProvisionedModelStatus = (typeof ProvisionedModelStatus)[keyof typeo
857
2463
  */
858
2464
  export interface GetProvisionedModelThroughputResponse {
859
2465
  /**
860
- * <p>The current number of model units requested to be available for this provisioned throughput.</p>
2466
+ * <p>The number of model units allocated to this Provisioned Throughput.</p>
861
2467
  * @public
862
2468
  */
863
2469
  modelUnits: number | undefined;
864
2470
  /**
865
- * <p>The desired number of model units that was requested to be available for this provisioned throughput.</p>
2471
+ * <p>The number of model units that was requested for this Provisioned Throughput.</p>
866
2472
  * @public
867
2473
  */
868
2474
  desiredModelUnits: number | undefined;
869
2475
  /**
870
- * <p>The name of the provisioned throughput.</p>
2476
+ * <p>The name of the Provisioned Throughput.</p>
871
2477
  * @public
872
2478
  */
873
2479
  provisionedModelName: string | undefined;
874
2480
  /**
875
- * <p>The ARN of the provisioned throughput.</p>
2481
+ * <p>The Amazon Resource Name (ARN) of the Provisioned Throughput.</p>
876
2482
  * @public
877
2483
  */
878
2484
  provisionedModelArn: string | undefined;
879
2485
  /**
880
- * <p>The ARN or name of the model associated with this provisioned throughput.</p>
2486
+ * <p>The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.</p>
881
2487
  * @public
882
2488
  */
883
2489
  modelArn: string | undefined;
884
2490
  /**
885
- * <p>The ARN of the new model to asssociate with this provisioned throughput.</p>
2491
+ * <p>The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the <code>modelArn</code> if updating hasn't completed.</p>
886
2492
  * @public
887
2493
  */
888
2494
  desiredModelArn: string | undefined;
889
2495
  /**
890
- * <p>ARN of the foundation model.</p>
2496
+ * <p>The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.</p>
891
2497
  * @public
892
2498
  */
893
2499
  foundationModelArn: string | undefined;
894
2500
  /**
895
- * <p>Status of the provisioned throughput. </p>
2501
+ * <p>The status of the Provisioned Throughput. </p>
896
2502
  * @public
897
2503
  */
898
2504
  status: ProvisionedModelStatus | undefined;
899
2505
  /**
900
- * <p>The timestamp of the creation time for this provisioned throughput. </p>
2506
+ * <p>The timestamp of the creation time for this Provisioned Throughput. </p>
901
2507
  * @public
902
2508
  */
903
2509
  creationTime: Date | undefined;
904
2510
  /**
905
- * <p>The timestamp of the last modified time of this provisioned throughput. </p>
2511
+ * <p>The timestamp of the last time that this Provisioned Throughput was modified. </p>
906
2512
  * @public
907
2513
  */
908
2514
  lastModifiedTime: Date | undefined;
909
2515
  /**
910
- * <p>Failure message for any issues that the create operation encounters.</p>
2516
+ * <p>A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.</p>
911
2517
  * @public
912
2518
  */
913
2519
  failureMessage?: string;
914
2520
  /**
915
- * <p>Commitment duration of the provisioned throughput.</p>
2521
+ * <p>Commitment duration of the Provisioned Throughput.</p>
916
2522
  * @public
917
2523
  */
918
2524
  commitmentDuration?: CommitmentDuration;
919
2525
  /**
920
- * <p>Commitment expiration time for the provisioned throughput.</p>
2526
+ * <p>The timestamp for when the commitment term for the Provisioned Throughput expires.</p>
921
2527
  * @public
922
2528
  */
923
2529
  commitmentExpirationTime?: Date;
@@ -938,42 +2544,44 @@ export type SortByProvisionedModels = (typeof SortByProvisionedModels)[keyof typ
938
2544
  */
939
2545
  export interface ListProvisionedModelThroughputsRequest {
940
2546
  /**
941
- * <p>Return provisioned capacities created after the specified time. </p>
2547
+ * <p>A filter that returns Provisioned Throughputs created after the specified time. </p>
942
2548
  * @public
943
2549
  */
944
2550
  creationTimeAfter?: Date;
945
2551
  /**
946
- * <p>Return provisioned capacities created before the specified time. </p>
2552
+ * <p>A filter that returns Provisioned Throughputs created before the specified time. </p>
947
2553
  * @public
948
2554
  */
949
2555
  creationTimeBefore?: Date;
950
2556
  /**
951
- * <p>Return the list of provisioned capacities that match the specified status.</p>
2557
+ * <p>A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.</p>
952
2558
  * @public
953
2559
  */
954
2560
  statusEquals?: ProvisionedModelStatus;
955
2561
  /**
956
- * <p>Return the list of provisioned capacities where their model ARN is equal to this parameter.</p>
2562
+ * <p>A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.</p>
957
2563
  * @public
958
2564
  */
959
2565
  modelArnEquals?: string;
960
2566
  /**
961
- * <p>Return the list of provisioned capacities if their name contains these characters.</p>
2567
+ * <p>A filter that returns Provisioned Throughputs if their name contains the expression that you specify.</p>
962
2568
  * @public
963
2569
  */
964
2570
  nameContains?: string;
965
2571
  /**
966
- * <p>THe maximum number of results to return in the response.</p>
2572
+ * <p>THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a <code>nextToken</code>
2573
+ * value. To see the next batch of results, send the <code>nextToken</code> value in another list request.</p>
967
2574
  * @public
968
2575
  */
969
2576
  maxResults?: number;
970
2577
  /**
971
- * <p>Continuation token from the previous response, for Amazon Bedrock to list the next set of results.</p>
2578
+ * <p>If there are more results than the number you specified in the <code>maxResults</code> field, the response returns a <code>nextToken</code>
2579
+ * value. To see the next batch of results, specify the <code>nextToken</code> value in this field.</p>
972
2580
  * @public
973
2581
  */
974
2582
  nextToken?: string;
975
2583
  /**
976
- * <p>The field to sort by in the returned list of provisioned capacities.</p>
2584
+ * <p>The field by which to sort the returned list of Provisioned Throughputs.</p>
977
2585
  * @public
978
2586
  */
979
2587
  sortBy?: SortByProvisionedModels;
@@ -984,67 +2592,75 @@ export interface ListProvisionedModelThroughputsRequest {
984
2592
  sortOrder?: SortOrder;
985
2593
  }
986
2594
  /**
987
- * <p>Set of fields associated with a provisioned throughput.</p>
2595
+ * <p>A summary of information about a Provisioned Throughput.</p>
2596
+ * <p>This data type is used in the following API operations:</p>
2597
+ * <ul>
2598
+ * <li>
2599
+ * <p>
2600
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax">ListProvisionedThroughputs response</a>
2601
+ * </p>
2602
+ * </li>
2603
+ * </ul>
988
2604
  * @public
989
2605
  */
990
2606
  export interface ProvisionedModelSummary {
991
2607
  /**
992
- * <p>The name of the provisioned throughput.</p>
2608
+ * <p>The name of the Provisioned Throughput.</p>
993
2609
  * @public
994
2610
  */
995
2611
  provisionedModelName: string | undefined;
996
2612
  /**
997
- * <p>The ARN of the provisioned throughput.</p>
2613
+ * <p>The Amazon Resource Name (ARN) of the Provisioned Throughput.</p>
998
2614
  * @public
999
2615
  */
1000
2616
  provisionedModelArn: string | undefined;
1001
2617
  /**
1002
- * <p>The ARN of the model associated with this provisioned throughput.</p>
2618
+ * <p>The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.</p>
1003
2619
  * @public
1004
2620
  */
1005
2621
  modelArn: string | undefined;
1006
2622
  /**
1007
- * <p>Desired model ARN.</p>
2623
+ * <p>The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the <code>modelArn</code> if updating hasn't completed.</p>
1008
2624
  * @public
1009
2625
  */
1010
2626
  desiredModelArn: string | undefined;
1011
2627
  /**
1012
- * <p>Foundation model ARN.</p>
2628
+ * <p>The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.</p>
1013
2629
  * @public
1014
2630
  */
1015
2631
  foundationModelArn: string | undefined;
1016
2632
  /**
1017
- * <p>The number of model units allocated.</p>
2633
+ * <p>The number of model units allocated to the Provisioned Throughput.</p>
1018
2634
  * @public
1019
2635
  */
1020
2636
  modelUnits: number | undefined;
1021
2637
  /**
1022
- * <p>Desired model units.</p>
2638
+ * <p>The number of model units that was requested to be allocated to the Provisioned Throughput.</p>
1023
2639
  * @public
1024
2640
  */
1025
2641
  desiredModelUnits: number | undefined;
1026
2642
  /**
1027
- * <p>Status of the provisioned throughput.</p>
2643
+ * <p>The status of the Provisioned Throughput.</p>
1028
2644
  * @public
1029
2645
  */
1030
2646
  status: ProvisionedModelStatus | undefined;
1031
2647
  /**
1032
- * <p>Commitment duration for the provisioned throughput.</p>
2648
+ * <p>The duration for which the Provisioned Throughput was committed.</p>
1033
2649
  * @public
1034
2650
  */
1035
2651
  commitmentDuration?: CommitmentDuration;
1036
2652
  /**
1037
- * <p>Commitment expiration time for the provisioned throughput.</p>
2653
+ * <p>The timestamp for when the commitment term of the Provisioned Throughput expires.</p>
1038
2654
  * @public
1039
2655
  */
1040
2656
  commitmentExpirationTime?: Date;
1041
2657
  /**
1042
- * <p>The time that this provisioned throughput was created. </p>
2658
+ * <p>The time that the Provisioned Throughput was created. </p>
1043
2659
  * @public
1044
2660
  */
1045
2661
  creationTime: Date | undefined;
1046
2662
  /**
1047
- * <p>The time that this provisioned throughput was last modified. </p>
2663
+ * <p>The time that the Provisioned Throughput was last modified. </p>
1048
2664
  * @public
1049
2665
  */
1050
2666
  lastModifiedTime: Date | undefined;
@@ -1054,12 +2670,12 @@ export interface ProvisionedModelSummary {
1054
2670
  */
1055
2671
  export interface ListProvisionedModelThroughputsResponse {
1056
2672
  /**
1057
- * <p>Continuation token for the next request to list the next set of results.</p>
2673
+ * <p>If there are more results than the number you specified in the <code>maxResults</code> field, this value is returned. To see the next batch of results, include this value in the <code>nextToken</code> field in another list request.</p>
1058
2674
  * @public
1059
2675
  */
1060
2676
  nextToken?: string;
1061
2677
  /**
1062
- * <p>List of summaries, one for each provisioned throughput in the response.</p>
2678
+ * <p>A list of summaries, one for each Provisioned Throughput in the response.</p>
1063
2679
  * @public
1064
2680
  */
1065
2681
  provisionedModelSummaries?: ProvisionedModelSummary[];
@@ -1069,17 +2685,26 @@ export interface ListProvisionedModelThroughputsResponse {
1069
2685
  */
1070
2686
  export interface UpdateProvisionedModelThroughputRequest {
1071
2687
  /**
1072
- * <p>The ARN or name of the provisioned throughput to update.</p>
2688
+ * <p>The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.</p>
1073
2689
  * @public
1074
2690
  */
1075
2691
  provisionedModelId: string | undefined;
1076
2692
  /**
1077
- * <p>The new name for this provisioned throughput.</p>
2693
+ * <p>The new name for this Provisioned Throughput.</p>
1078
2694
  * @public
1079
2695
  */
1080
2696
  desiredProvisionedModelName?: string;
1081
2697
  /**
1082
- * <p>The ARN of the new model to associate with this provisioned throughput.</p>
2698
+ * <p>The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.</p>
2699
+ * <p>If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:</p>
2700
+ * <ul>
2701
+ * <li>
2702
+ * <p>The base model from which the custom model was customized.</p>
2703
+ * </li>
2704
+ * <li>
2705
+ * <p>Another custom model that was customized from the same base model as the custom model.</p>
2706
+ * </li>
2707
+ * </ul>
1083
2708
  * @public
1084
2709
  */
1085
2710
  desiredModelId?: string;
@@ -1094,7 +2719,7 @@ export interface UpdateProvisionedModelThroughputResponse {
1094
2719
  */
1095
2720
  export interface ListTagsForResourceRequest {
1096
2721
  /**
1097
- * <p>The ARN of the resource.</p>
2722
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
1098
2723
  * @public
1099
2724
  */
1100
2725
  resourceARN: string | undefined;
@@ -1114,7 +2739,7 @@ export interface ListTagsForResourceResponse {
1114
2739
  */
1115
2740
  export interface TagResourceRequest {
1116
2741
  /**
1117
- * <p>The ARN of the resource to tag.</p>
2742
+ * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
1118
2743
  * @public
1119
2744
  */
1120
2745
  resourceARN: string | undefined;
@@ -1134,7 +2759,7 @@ export interface TagResourceResponse {
1134
2759
  */
1135
2760
  export interface UntagResourceRequest {
1136
2761
  /**
1137
- * <p>The ARN of the resource to untag.</p>
2762
+ * <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
1138
2763
  * @public
1139
2764
  */
1140
2765
  resourceARN: string | undefined;
@@ -1170,17 +2795,17 @@ export interface VpcConfig {
1170
2795
  */
1171
2796
  export interface CreateModelCustomizationJobRequest {
1172
2797
  /**
1173
- * <p>Enter a unique name for the fine-tuning job.</p>
2798
+ * <p>A name for the fine-tuning job.</p>
1174
2799
  * @public
1175
2800
  */
1176
2801
  jobName: string | undefined;
1177
2802
  /**
1178
- * <p>Enter a name for the custom model.</p>
2803
+ * <p>A name for the resulting custom model.</p>
1179
2804
  * @public
1180
2805
  */
1181
2806
  customModelName: string | undefined;
1182
2807
  /**
1183
- * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon Bedrock can assume to perform tasks on your behalf.
2808
+ * <p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.
1184
2809
  * For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket.
1185
2810
  * To pass this role to Amazon Bedrock, the caller of this API must have the <code>iam:PassRole</code> permission.
1186
2811
  * </p>
@@ -1188,7 +2813,8 @@ export interface CreateModelCustomizationJobRequest {
1188
2813
  */
1189
2814
  roleArn: string | undefined;
1190
2815
  /**
1191
- * <p>Unique token value that you can provide. The GetModelCustomizationJob response includes the same token value.</p>
2816
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
2817
+ * Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
1192
2818
  * @public
1193
2819
  */
1194
2820
  clientRequestToken?: string;
@@ -1208,12 +2834,12 @@ export interface CreateModelCustomizationJobRequest {
1208
2834
  */
1209
2835
  customModelKmsKeyId?: string;
1210
2836
  /**
1211
- * <p>Assign tags to the job.</p>
2837
+ * <p>Tags to attach to the job.</p>
1212
2838
  * @public
1213
2839
  */
1214
2840
  jobTags?: Tag[];
1215
2841
  /**
1216
- * <p>Assign tags to the custom model.</p>
2842
+ * <p>Tags to attach to the resulting custom model.</p>
1217
2843
  * @public
1218
2844
  */
1219
2845
  customModelTags?: Tag[];
@@ -1233,13 +2859,13 @@ export interface CreateModelCustomizationJobRequest {
1233
2859
  */
1234
2860
  outputDataConfig: OutputDataConfig | undefined;
1235
2861
  /**
1236
- * <p>Parameters related to tuning the model.</p>
2862
+ * <p>Parameters related to tuning the model. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
1237
2863
  * @public
1238
2864
  */
1239
2865
  hyperParameters: Record<string, string> | undefined;
1240
2866
  /**
1241
2867
  * <p>VPC configuration (optional). Configuration parameters for the
1242
- * private Virtual Private Cloud (VPC) that contains the resources you are using for this job.</p>
2868
+ * private Virtual Private Cloud (VPC) that contains the resources you are using for this job.</p>
1243
2869
  * @public
1244
2870
  */
1245
2871
  vpcConfig?: VpcConfig;
@@ -1249,7 +2875,7 @@ export interface CreateModelCustomizationJobRequest {
1249
2875
  */
1250
2876
  export interface CreateModelCustomizationJobResponse {
1251
2877
  /**
1252
- * <p>ARN of the fine tuning job</p>
2878
+ * <p>Amazon Resource Name (ARN) of the fine tuning job</p>
1253
2879
  * @public
1254
2880
  */
1255
2881
  jobArn: string | undefined;
@@ -1284,7 +2910,7 @@ export type ModelCustomizationJobStatus = (typeof ModelCustomizationJobStatus)[k
1284
2910
  */
1285
2911
  export interface GetModelCustomizationJobResponse {
1286
2912
  /**
1287
- * <p>The ARN of the customization job.</p>
2913
+ * <p>The Amazon Resource Name (ARN) of the customization job.</p>
1288
2914
  * @public
1289
2915
  */
1290
2916
  jobArn: string | undefined;
@@ -1299,23 +2925,23 @@ export interface GetModelCustomizationJobResponse {
1299
2925
  */
1300
2926
  outputModelName: string | undefined;
1301
2927
  /**
1302
- * <p>The ARN of the output model.</p>
2928
+ * <p>The Amazon Resource Name (ARN) of the output model.</p>
1303
2929
  * @public
1304
2930
  */
1305
2931
  outputModelArn?: string;
1306
2932
  /**
1307
- * <p>The token that you specified in the CreateCustomizationJob request.</p>
2933
+ * <p>The token that you specified in the <code>CreateCustomizationJob</code> request.</p>
1308
2934
  * @public
1309
2935
  */
1310
2936
  clientRequestToken?: string;
1311
2937
  /**
1312
- * <p>The ARN of the IAM role.</p>
2938
+ * <p>The Amazon Resource Name (ARN) of the IAM role.</p>
1313
2939
  * @public
1314
2940
  */
1315
2941
  roleArn: string | undefined;
1316
2942
  /**
1317
2943
  * <p>The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use.
1318
- * If the job failed, the failure message contains information about why the job failed.</p>
2944
+ * If the job failed, the failure message contains information about why the job failed.</p>
1319
2945
  * @public
1320
2946
  */
1321
2947
  status?: ModelCustomizationJobStatus;
@@ -1340,22 +2966,22 @@ export interface GetModelCustomizationJobResponse {
1340
2966
  */
1341
2967
  endTime?: Date;
1342
2968
  /**
1343
- * <p>ARN of the base model.</p>
2969
+ * <p>Amazon Resource Name (ARN) of the base model.</p>
1344
2970
  * @public
1345
2971
  */
1346
2972
  baseModelArn: string | undefined;
1347
2973
  /**
1348
- * <p>The hyperparameter values for the job. For information about hyperparameters for specific models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-guidelines.html">Guidelines for model customization</a>.</p>
2974
+ * <p>The hyperparameter values for the job. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
1349
2975
  * @public
1350
2976
  */
1351
2977
  hyperParameters: Record<string, string> | undefined;
1352
2978
  /**
1353
- * <p>S3 Location of the training data.</p>
2979
+ * <p>Contains information about the training dataset.</p>
1354
2980
  * @public
1355
2981
  */
1356
2982
  trainingDataConfig: TrainingDataConfig | undefined;
1357
2983
  /**
1358
- * <p>Array of up to 10 validators.</p>
2984
+ * <p>Contains information about the validation dataset.</p>
1359
2985
  * @public
1360
2986
  */
1361
2987
  validationDataConfig: ValidationDataConfig | undefined;
@@ -1375,7 +3001,7 @@ export interface GetModelCustomizationJobResponse {
1375
3001
  */
1376
3002
  outputModelKmsKeyArn?: string;
1377
3003
  /**
1378
- * <p>Metrics associated with the custom job.</p>
3004
+ * <p>Contains training metrics from the job creation.</p>
1379
3005
  * @public
1380
3006
  */
1381
3007
  trainingMetrics?: TrainingMetrics;
@@ -1390,17 +3016,6 @@ export interface GetModelCustomizationJobResponse {
1390
3016
  */
1391
3017
  vpcConfig?: VpcConfig;
1392
3018
  }
1393
- /**
1394
- * @public
1395
- * @enum
1396
- */
1397
- export declare const SortJobsBy: {
1398
- readonly CREATION_TIME: "CreationTime";
1399
- };
1400
- /**
1401
- * @public
1402
- */
1403
- export type SortJobsBy = (typeof SortJobsBy)[keyof typeof SortJobsBy];
1404
3019
  /**
1405
3020
  * @public
1406
3021
  * @enum
@@ -1467,12 +3082,12 @@ export interface ListModelCustomizationJobsRequest {
1467
3082
  */
1468
3083
  export interface ModelCustomizationJobSummary {
1469
3084
  /**
1470
- * <p>ARN of the customization job.</p>
3085
+ * <p>Amazon Resource Name (ARN) of the customization job.</p>
1471
3086
  * @public
1472
3087
  */
1473
3088
  jobArn: string | undefined;
1474
3089
  /**
1475
- * <p>ARN of the base model.</p>
3090
+ * <p>Amazon Resource Name (ARN) of the base model.</p>
1476
3091
  * @public
1477
3092
  */
1478
3093
  baseModelArn: string | undefined;
@@ -1502,7 +3117,7 @@ export interface ModelCustomizationJobSummary {
1502
3117
  */
1503
3118
  endTime?: Date;
1504
3119
  /**
1505
- * <p>ARN of the custom model.</p>
3120
+ * <p>Amazon Resource Name (ARN) of the custom model.</p>
1506
3121
  * @public
1507
3122
  */
1508
3123
  customModelArn?: string;
@@ -1547,3 +3162,99 @@ export interface StopModelCustomizationJobRequest {
1547
3162
  */
1548
3163
  export interface StopModelCustomizationJobResponse {
1549
3164
  }
3165
+ /**
3166
+ * @internal
3167
+ */
3168
+ export declare const EvaluationDatasetFilterSensitiveLog: (obj: EvaluationDataset) => any;
3169
+ /**
3170
+ * @internal
3171
+ */
3172
+ export declare const EvaluationDatasetMetricConfigFilterSensitiveLog: (obj: EvaluationDatasetMetricConfig) => any;
3173
+ /**
3174
+ * @internal
3175
+ */
3176
+ export declare const AutomatedEvaluationConfigFilterSensitiveLog: (obj: AutomatedEvaluationConfig) => any;
3177
+ /**
3178
+ * @internal
3179
+ */
3180
+ export declare const HumanEvaluationCustomMetricFilterSensitiveLog: (obj: HumanEvaluationCustomMetric) => any;
3181
+ /**
3182
+ * @internal
3183
+ */
3184
+ export declare const HumanWorkflowConfigFilterSensitiveLog: (obj: HumanWorkflowConfig) => any;
3185
+ /**
3186
+ * @internal
3187
+ */
3188
+ export declare const HumanEvaluationConfigFilterSensitiveLog: (obj: HumanEvaluationConfig) => any;
3189
+ /**
3190
+ * @internal
3191
+ */
3192
+ export declare const EvaluationConfigFilterSensitiveLog: (obj: EvaluationConfig) => any;
3193
+ /**
3194
+ * @internal
3195
+ */
3196
+ export declare const EvaluationBedrockModelFilterSensitiveLog: (obj: EvaluationBedrockModel) => any;
3197
+ /**
3198
+ * @internal
3199
+ */
3200
+ export declare const EvaluationModelConfigFilterSensitiveLog: (obj: EvaluationModelConfig) => any;
3201
+ /**
3202
+ * @internal
3203
+ */
3204
+ export declare const EvaluationInferenceConfigFilterSensitiveLog: (obj: EvaluationInferenceConfig) => any;
3205
+ /**
3206
+ * @internal
3207
+ */
3208
+ export declare const CreateEvaluationJobRequestFilterSensitiveLog: (obj: CreateEvaluationJobRequest) => any;
3209
+ /**
3210
+ * @internal
3211
+ */
3212
+ export declare const GetEvaluationJobRequestFilterSensitiveLog: (obj: GetEvaluationJobRequest) => any;
3213
+ /**
3214
+ * @internal
3215
+ */
3216
+ export declare const GetEvaluationJobResponseFilterSensitiveLog: (obj: GetEvaluationJobResponse) => any;
3217
+ /**
3218
+ * @internal
3219
+ */
3220
+ export declare const StopEvaluationJobRequestFilterSensitiveLog: (obj: StopEvaluationJobRequest) => any;
3221
+ /**
3222
+ * @internal
3223
+ */
3224
+ export declare const GuardrailTopicConfigFilterSensitiveLog: (obj: GuardrailTopicConfig) => any;
3225
+ /**
3226
+ * @internal
3227
+ */
3228
+ export declare const GuardrailTopicPolicyConfigFilterSensitiveLog: (obj: GuardrailTopicPolicyConfig) => any;
3229
+ /**
3230
+ * @internal
3231
+ */
3232
+ export declare const CreateGuardrailRequestFilterSensitiveLog: (obj: CreateGuardrailRequest) => any;
3233
+ /**
3234
+ * @internal
3235
+ */
3236
+ export declare const CreateGuardrailVersionRequestFilterSensitiveLog: (obj: CreateGuardrailVersionRequest) => any;
3237
+ /**
3238
+ * @internal
3239
+ */
3240
+ export declare const GuardrailTopicFilterSensitiveLog: (obj: GuardrailTopic) => any;
3241
+ /**
3242
+ * @internal
3243
+ */
3244
+ export declare const GuardrailTopicPolicyFilterSensitiveLog: (obj: GuardrailTopicPolicy) => any;
3245
+ /**
3246
+ * @internal
3247
+ */
3248
+ export declare const GetGuardrailResponseFilterSensitiveLog: (obj: GetGuardrailResponse) => any;
3249
+ /**
3250
+ * @internal
3251
+ */
3252
+ export declare const GuardrailSummaryFilterSensitiveLog: (obj: GuardrailSummary) => any;
3253
+ /**
3254
+ * @internal
3255
+ */
3256
+ export declare const ListGuardrailsResponseFilterSensitiveLog: (obj: ListGuardrailsResponse) => any;
3257
+ /**
3258
+ * @internal
3259
+ */
3260
+ export declare const UpdateGuardrailRequestFilterSensitiveLog: (obj: UpdateGuardrailRequest) => any;