aws-sdk 2.1643.0 → 2.1645.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.
@@ -13,19 +13,19 @@ declare class BedrockRuntime extends Service {
13
13
  constructor(options?: BedrockRuntime.Types.ClientConfiguration)
14
14
  config: Config & BedrockRuntime.Types.ClientConfiguration;
15
15
  /**
16
- * Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For more information, see Run inference in the Bedrock User Guide. This operation requires permission for the bedrock:InvokeModel action.
16
+ * Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide For example code, see Converse API examples in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModel action.
17
17
  */
18
18
  converse(params: BedrockRuntime.Types.ConverseRequest, callback?: (err: AWSError, data: BedrockRuntime.Types.ConverseResponse) => void): Request<BedrockRuntime.Types.ConverseResponse, AWSError>;
19
19
  /**
20
- * Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For more information, see Run inference in the Bedrock User Guide. This operation requires permission for the bedrock:InvokeModel action.
20
+ * Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide For example code, see Converse API examples in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModel action.
21
21
  */
22
22
  converse(callback?: (err: AWSError, data: BedrockRuntime.Types.ConverseResponse) => void): Request<BedrockRuntime.Types.ConverseResponse, AWSError>;
23
23
  /**
24
- * Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For more information, see Run inference in the Bedrock User Guide. To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response. For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModelWithResponseStream action.
24
+ * Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response. For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide For example code, see Conversation streaming example in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModelWithResponseStream action.
25
25
  */
26
26
  converseStream(params: BedrockRuntime.Types.ConverseStreamRequest, callback?: (err: AWSError, data: BedrockRuntime.Types.ConverseStreamResponse) => void): Request<BedrockRuntime.Types.ConverseStreamResponse, AWSError>;
27
27
  /**
28
- * Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. For more information, see Run inference in the Bedrock User Guide. To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response. For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModelWithResponseStream action.
28
+ * Sends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response. For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide For example code, see Conversation streaming example in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModelWithResponseStream action.
29
29
  */
30
30
  converseStream(callback?: (err: AWSError, data: BedrockRuntime.Types.ConverseStreamResponse) => void): Request<BedrockRuntime.Types.ConverseStreamResponse, AWSError>;
31
31
  /**
@@ -68,6 +68,10 @@ declare namespace BedrockRuntime {
68
68
  * The result for a tool request that a model makes.
69
69
  */
70
70
  toolResult?: ToolResultBlock;
71
+ /**
72
+ * Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message. For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. &lt;/p&gt;
73
+ */
74
+ guardContent?: GuardrailConverseContentBlock;
71
75
  }
72
76
  export interface ContentBlockDelta {
73
77
  /**
@@ -147,12 +151,16 @@ declare namespace BedrockRuntime {
147
151
  * Configuration information for the tools that the model can use when generating a response. This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.
148
152
  */
149
153
  toolConfig?: ToolConfiguration;
154
+ /**
155
+ * Configuration information for a guardrail that you want to use in the request.
156
+ */
157
+ guardrailConfig?: GuardrailConfiguration;
150
158
  /**
151
159
  * Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.
152
160
  */
153
161
  additionalModelRequestFields?: Document;
154
162
  /**
155
- * Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths. [ "/stop_sequence" ] For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation. Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.
163
+ * Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths. [ "/stop_sequence" ] For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation. Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.
156
164
  */
157
165
  additionalModelResponseFieldPaths?: ConverseRequestAdditionalModelResponseFieldPathsList;
158
166
  }
@@ -179,6 +187,10 @@ declare namespace BedrockRuntime {
179
187
  * Additional fields in the response that are unique to the model.
180
188
  */
181
189
  additionalModelResponseFields?: Document;
190
+ /**
191
+ * A trace object that contains information about the Guardrail behavior.
192
+ */
193
+ trace?: ConverseTrace;
182
194
  }
183
195
  export interface ConverseStreamMetadataEvent {
184
196
  /**
@@ -189,6 +201,10 @@ declare namespace BedrockRuntime {
189
201
  * The metrics for the conversation stream metadata event.
190
202
  */
191
203
  metrics: ConverseStreamMetrics;
204
+ /**
205
+ * The trace object in the response from ConverseStream that contains information about the guardrail behavior.
206
+ */
207
+ trace?: ConverseStreamTrace;
192
208
  }
193
209
  export interface ConverseStreamMetrics {
194
210
  /**
@@ -218,12 +234,16 @@ declare namespace BedrockRuntime {
218
234
  * Configuration information for the tools that the model can use when generating a response. This field is only supported by Anthropic Claude 3 models.
219
235
  */
220
236
  toolConfig?: ToolConfiguration;
237
+ /**
238
+ * Configuration information for a guardrail that you want to use in the request.
239
+ */
240
+ guardrailConfig?: GuardrailStreamConfiguration;
221
241
  /**
222
242
  * Additional inference parameters that the model supports, beyond the base set of inference parameters that ConverseStream supports in the inferenceConfig field.
223
243
  */
224
244
  additionalModelRequestFields?: Document;
225
245
  /**
226
- * Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths. [ "/stop_sequence" ] For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation. ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.
246
+ * Additional model parameters field paths to return in the response. ConverseStream returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths. [ "/stop_sequence" ] For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation. ConverseStream rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by ConverseStream.
227
247
  */
228
248
  additionalModelResponseFieldPaths?: ConverseStreamRequestAdditionalModelResponseFieldPathsList;
229
249
  }
@@ -235,10 +255,235 @@ declare namespace BedrockRuntime {
235
255
  */
236
256
  stream?: ConverseStreamOutput;
237
257
  }
258
+ export interface ConverseStreamTrace {
259
+ /**
260
+ * The guardrail trace object.
261
+ */
262
+ guardrail?: GuardrailTraceAssessment;
263
+ }
264
+ export interface ConverseTrace {
265
+ /**
266
+ * The guardrail trace object.
267
+ */
268
+ guardrail?: GuardrailTraceAssessment;
269
+ }
238
270
  export interface Document {
239
271
  }
272
+ export interface GuardrailAssessment {
273
+ /**
274
+ * The topic policy.
275
+ */
276
+ topicPolicy?: GuardrailTopicPolicyAssessment;
277
+ /**
278
+ * The content policy.
279
+ */
280
+ contentPolicy?: GuardrailContentPolicyAssessment;
281
+ /**
282
+ * The word policy.
283
+ */
284
+ wordPolicy?: GuardrailWordPolicyAssessment;
285
+ /**
286
+ * The sensitive information policy.
287
+ */
288
+ sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
289
+ }
290
+ export type GuardrailAssessmentList = GuardrailAssessment[];
291
+ export type GuardrailAssessmentListMap = {[key: string]: GuardrailAssessmentList};
292
+ export type GuardrailAssessmentMap = {[key: string]: GuardrailAssessment};
293
+ export interface GuardrailConfiguration {
294
+ /**
295
+ * The identifier for the guardrail.
296
+ */
297
+ guardrailIdentifier: GuardrailIdentifier;
298
+ /**
299
+ * The version of the guardrail.
300
+ */
301
+ guardrailVersion: GuardrailVersion;
302
+ /**
303
+ * The trace behavior for the guardrail.
304
+ */
305
+ trace?: GuardrailTrace;
306
+ }
307
+ export interface GuardrailContentFilter {
308
+ /**
309
+ * The guardrail type.
310
+ */
311
+ type: GuardrailContentFilterType;
312
+ /**
313
+ * The guardrail confidence.
314
+ */
315
+ confidence: GuardrailContentFilterConfidence;
316
+ /**
317
+ * The guardrail action.
318
+ */
319
+ action: GuardrailContentPolicyAction;
320
+ }
321
+ export type GuardrailContentFilterConfidence = "NONE"|"LOW"|"MEDIUM"|"HIGH"|string;
322
+ export type GuardrailContentFilterList = GuardrailContentFilter[];
323
+ export type GuardrailContentFilterType = "INSULTS"|"HATE"|"SEXUAL"|"VIOLENCE"|"MISCONDUCT"|"PROMPT_ATTACK"|string;
324
+ export type GuardrailContentPolicyAction = "BLOCKED"|string;
325
+ export interface GuardrailContentPolicyAssessment {
326
+ /**
327
+ * The content policy filters.
328
+ */
329
+ filters: GuardrailContentFilterList;
330
+ }
331
+ export interface GuardrailConverseContentBlock {
332
+ /**
333
+ * The text to guard.
334
+ */
335
+ text?: GuardrailConverseTextBlock;
336
+ }
337
+ export interface GuardrailConverseTextBlock {
338
+ /**
339
+ * The text that you want to guard.
340
+ */
341
+ text: String;
342
+ }
343
+ export interface GuardrailCustomWord {
344
+ /**
345
+ * The match for the custom word.
346
+ */
347
+ match: String;
348
+ /**
349
+ * The action for the custom word.
350
+ */
351
+ action: GuardrailWordPolicyAction;
352
+ }
353
+ export type GuardrailCustomWordList = GuardrailCustomWord[];
240
354
  export type GuardrailIdentifier = string;
355
+ export interface GuardrailManagedWord {
356
+ /**
357
+ * The match for the managed word.
358
+ */
359
+ match: String;
360
+ /**
361
+ * The type for the managed word.
362
+ */
363
+ type: GuardrailManagedWordType;
364
+ /**
365
+ * The action for the managed word.
366
+ */
367
+ action: GuardrailWordPolicyAction;
368
+ }
369
+ export type GuardrailManagedWordList = GuardrailManagedWord[];
370
+ export type GuardrailManagedWordType = "PROFANITY"|string;
371
+ export type GuardrailOutputText = string;
372
+ export interface GuardrailPiiEntityFilter {
373
+ /**
374
+ * The PII entity filter match.
375
+ */
376
+ match: String;
377
+ /**
378
+ * The PII entity filter type.
379
+ */
380
+ type: GuardrailPiiEntityType;
381
+ /**
382
+ * The PII entity filter action.
383
+ */
384
+ action: GuardrailSensitiveInformationPolicyAction;
385
+ }
386
+ export type GuardrailPiiEntityFilterList = GuardrailPiiEntityFilter[];
387
+ export type GuardrailPiiEntityType = "ADDRESS"|"AGE"|"AWS_ACCESS_KEY"|"AWS_SECRET_KEY"|"CA_HEALTH_NUMBER"|"CA_SOCIAL_INSURANCE_NUMBER"|"CREDIT_DEBIT_CARD_CVV"|"CREDIT_DEBIT_CARD_EXPIRY"|"CREDIT_DEBIT_CARD_NUMBER"|"DRIVER_ID"|"EMAIL"|"INTERNATIONAL_BANK_ACCOUNT_NUMBER"|"IP_ADDRESS"|"LICENSE_PLATE"|"MAC_ADDRESS"|"NAME"|"PASSWORD"|"PHONE"|"PIN"|"SWIFT_CODE"|"UK_NATIONAL_HEALTH_SERVICE_NUMBER"|"UK_NATIONAL_INSURANCE_NUMBER"|"UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"|"URL"|"USERNAME"|"US_BANK_ACCOUNT_NUMBER"|"US_BANK_ROUTING_NUMBER"|"US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"|"US_PASSPORT_NUMBER"|"US_SOCIAL_SECURITY_NUMBER"|"VEHICLE_IDENTIFICATION_NUMBER"|string;
388
+ export interface GuardrailRegexFilter {
389
+ /**
390
+ * The regex filter name.
391
+ */
392
+ name?: String;
393
+ /**
394
+ * The regesx filter match.
395
+ */
396
+ match?: String;
397
+ /**
398
+ * The regex query.
399
+ */
400
+ regex?: String;
401
+ /**
402
+ * The region filter action.
403
+ */
404
+ action: GuardrailSensitiveInformationPolicyAction;
405
+ }
406
+ export type GuardrailRegexFilterList = GuardrailRegexFilter[];
407
+ export type GuardrailSensitiveInformationPolicyAction = "ANONYMIZED"|"BLOCKED"|string;
408
+ export interface GuardrailSensitiveInformationPolicyAssessment {
409
+ /**
410
+ * The PII entities in the assessment.
411
+ */
412
+ piiEntities: GuardrailPiiEntityFilterList;
413
+ /**
414
+ * The regex queries in the assessment.
415
+ */
416
+ regexes: GuardrailRegexFilterList;
417
+ }
418
+ export interface GuardrailStreamConfiguration {
419
+ /**
420
+ * The identifier for the guardrail.
421
+ */
422
+ guardrailIdentifier: GuardrailIdentifier;
423
+ /**
424
+ * The version of the guardrail.
425
+ */
426
+ guardrailVersion: GuardrailVersion;
427
+ /**
428
+ * The trace behavior for the guardrail.
429
+ */
430
+ trace?: GuardrailTrace;
431
+ /**
432
+ * The processing mode. The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.
433
+ */
434
+ streamProcessingMode?: GuardrailStreamProcessingMode;
435
+ }
436
+ export type GuardrailStreamProcessingMode = "sync"|"async"|string;
437
+ export interface GuardrailTopic {
438
+ /**
439
+ * The name for the guardrail.
440
+ */
441
+ name: String;
442
+ /**
443
+ * The type behavior that the guardrail should perform when the model detects the topic.
444
+ */
445
+ type: GuardrailTopicType;
446
+ /**
447
+ * The action the guardrail should take when it intervenes on a topic.
448
+ */
449
+ action: GuardrailTopicPolicyAction;
450
+ }
451
+ export type GuardrailTopicList = GuardrailTopic[];
452
+ export type GuardrailTopicPolicyAction = "BLOCKED"|string;
453
+ export interface GuardrailTopicPolicyAssessment {
454
+ /**
455
+ * The topics in the assessment.
456
+ */
457
+ topics: GuardrailTopicList;
458
+ }
459
+ export type GuardrailTopicType = "DENY"|string;
460
+ export type GuardrailTrace = "enabled"|"disabled"|string;
461
+ export interface GuardrailTraceAssessment {
462
+ /**
463
+ * The output from the model.
464
+ */
465
+ modelOutput?: ModelOutputs;
466
+ /**
467
+ * The input assessment.
468
+ */
469
+ inputAssessment?: GuardrailAssessmentMap;
470
+ /**
471
+ * the output assessments.
472
+ */
473
+ outputAssessments?: GuardrailAssessmentListMap;
474
+ }
241
475
  export type GuardrailVersion = string;
476
+ export type GuardrailWordPolicyAction = "BLOCKED"|string;
477
+ export interface GuardrailWordPolicyAssessment {
478
+ /**
479
+ * Custom words in the assessment.
480
+ */
481
+ customWords: GuardrailCustomWordList;
482
+ /**
483
+ * Managed word lists in the assessment.
484
+ */
485
+ managedWordLists: GuardrailManagedWordList;
486
+ }
242
487
  export interface ImageBlock {
243
488
  /**
244
489
  * The format of the image.
@@ -259,7 +504,7 @@ declare namespace BedrockRuntime {
259
504
  export type ImageSourceBytesBlob = Buffer|Uint8Array|Blob|string;
260
505
  export interface InferenceConfiguration {
261
506
  /**
262
- * The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundatio{ "messages": [ { "role": "user", "content": [ { "text": "what's the weather in Queens, NY and Austin, TX?" } ] }, { "role": "assistant", "content": [ { "toolUse": { "toolUseId": "1", "name": "get_weather", "input": { "city": "Queens", "state": "NY" } } }, { "toolUse": { "toolUseId": "2", "name": "get_weather", "input": { "city": "Austin", "state": "TX" } } } ] }, { "role": "user", "content": [ { "toolResult": { "toolUseId": "2", "content": [ { "json": { "weather": "40" } } ] } }, { "text": "..." }, { "toolResult": { "toolUseId": "1", "content": [ { "text": "result text" } ] } } ] } ], "toolConfig": { "tools": [ { "name": "get_weather", "description": "Get weather", "inputSchema": { "type": "object", "properties": { "city": { "type": "string", "description": "City of location" }, "state": { "type": "string", "description": "State of location" } }, "required": ["city", "state"] } } ] } } n models.
507
+ * The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see Inference parameters for foundation models.
263
508
  */
264
509
  maxTokens?: InferenceConfigurationMaxTokensInteger;
265
510
  /**
@@ -285,11 +530,11 @@ declare namespace BedrockRuntime {
285
530
  export type InvokeModelIdentifier = string;
286
531
  export interface InvokeModelRequest {
287
532
  /**
288
- * The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
533
+ * The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
289
534
  */
290
535
  body: Body;
291
536
  /**
292
- * The MIME type of the input data in the request. The default value is application/json.
537
+ * The MIME type of the input data in the request. You must specify application/json.
293
538
  */
294
539
  contentType?: MimeType;
295
540
  /**
@@ -325,11 +570,11 @@ declare namespace BedrockRuntime {
325
570
  }
326
571
  export interface InvokeModelWithResponseStreamRequest {
327
572
  /**
328
- * The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
573
+ * The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.
329
574
  */
330
575
  body: Body;
331
576
  /**
332
- * The MIME type of the input data in the request. The default value is application/json.
577
+ * The MIME type of the input data in the request. You must specify application/json.
333
578
  */
334
579
  contentType?: MimeType;
335
580
  /**
@@ -392,6 +637,7 @@ declare namespace BedrockRuntime {
392
637
  }
393
638
  export type Messages = Message[];
394
639
  export type MimeType = string;
640
+ export type ModelOutputs = GuardrailOutputText[];
395
641
  export interface ModelStreamErrorException {
396
642
  message?: NonBlankString;
397
643
  /**
@@ -424,13 +670,17 @@ declare namespace BedrockRuntime {
424
670
  name: ToolName;
425
671
  }
426
672
  export type StatusCode = number;
427
- export type StopReason = "end_turn"|"tool_use"|"max_tokens"|"stop_sequence"|"content_filtered"|string;
673
+ export type StopReason = "end_turn"|"tool_use"|"max_tokens"|"stop_sequence"|"guardrail_intervened"|"content_filtered"|string;
428
674
  export type String = string;
429
675
  export interface SystemContentBlock {
430
676
  /**
431
677
  * A system prompt for the model.
432
678
  */
433
679
  text?: NonEmptyString;
680
+ /**
681
+ * A content block to assess with the guardrail. Use with the Converse API (Converse and ConverseStream). For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
682
+ */
683
+ guardContent?: GuardrailConverseContentBlock;
434
684
  }
435
685
  export type SystemContentBlocks = SystemContentBlock[];
436
686
  export interface ThrottlingException {
@@ -461,7 +711,7 @@ declare namespace BedrockRuntime {
461
711
  }
462
712
  export interface ToolChoice {
463
713
  /**
464
- * The Model automatically decides if a tool should be called or to whether to generate text instead.
714
+ * (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
465
715
  */
466
716
  auto?: AutoToolChoice;
467
717
  /**
@@ -469,7 +719,7 @@ declare namespace BedrockRuntime {
469
719
  */
470
720
  any?: AnyToolChoice;
471
721
  /**
472
- * The Model must request the specified tool.
722
+ * The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
473
723
  */
474
724
  tool?: SpecificToolChoice;
475
725
  }
package/clients/eks.d.ts CHANGED
@@ -1896,7 +1896,33 @@ declare namespace EKS {
1896
1896
  * Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
1897
1897
  */
1898
1898
  tags?: TagMap;
1899
+ /**
1900
+ * The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.
1901
+ */
1902
+ health?: FargateProfileHealth;
1903
+ }
1904
+ export interface FargateProfileHealth {
1905
+ /**
1906
+ * Any issues that are associated with the Fargate profile.
1907
+ */
1908
+ issues?: FargateProfileIssueList;
1909
+ }
1910
+ export interface FargateProfileIssue {
1911
+ /**
1912
+ * A brief description of the error.
1913
+ */
1914
+ code?: FargateProfileIssueCode;
1915
+ /**
1916
+ * The error message associated with the issue.
1917
+ */
1918
+ message?: String;
1919
+ /**
1920
+ * The Amazon Web Services resources that are affected by this issue.
1921
+ */
1922
+ resourceIds?: StringList;
1899
1923
  }
1924
+ export type FargateProfileIssueCode = "PodExecutionRoleAlreadyInUse"|"AccessDenied"|"ClusterUnreachable"|"InternalFailure"|string;
1925
+ export type FargateProfileIssueList = FargateProfileIssue[];
1900
1926
  export type FargateProfileLabel = {[key: string]: String};
1901
1927
  export interface FargateProfileSelector {
1902
1928
  /**
@@ -627,6 +627,10 @@ declare namespace OpenSearch {
627
627
  * Container for information about the SAML configuration for OpenSearch Dashboards.
628
628
  */
629
629
  SAMLOptions?: SAMLOptionsOutput;
630
+ /**
631
+ * Container for information about the JWT configuration of the Amazon OpenSearch Service.
632
+ */
633
+ JWTOptions?: JWTOptionsOutput;
630
634
  /**
631
635
  * Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
632
636
  */
@@ -653,6 +657,10 @@ declare namespace OpenSearch {
653
657
  * Container for information about the SAML configuration for OpenSearch Dashboards.
654
658
  */
655
659
  SAMLOptions?: SAMLOptionsInput;
660
+ /**
661
+ * Container for information about the JWT configuration of the Amazon OpenSearch Service.
662
+ */
663
+ JWTOptions?: JWTOptionsInput;
656
664
  /**
657
665
  * True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
658
666
  */
@@ -2324,7 +2332,7 @@ declare namespace OpenSearch {
2324
2332
  */
2325
2333
  Description?: DataSourceDescription;
2326
2334
  /**
2327
- * The status of the data source response.
2335
+ * The status of the data source.
2328
2336
  */
2329
2337
  Status?: DataSourceStatus;
2330
2338
  }
@@ -2540,6 +2548,42 @@ declare namespace OpenSearch {
2540
2548
  export type IntegerClass = number;
2541
2549
  export type Issue = string;
2542
2550
  export type Issues = Issue[];
2551
+ export interface JWTOptionsInput {
2552
+ /**
2553
+ * True to enable JWT authentication and authorization for a domain.
2554
+ */
2555
+ Enabled?: Boolean;
2556
+ /**
2557
+ * Element of the JWT assertion to use for the user name.
2558
+ */
2559
+ SubjectKey?: SubjectKey;
2560
+ /**
2561
+ * Element of the JWT assertion to use for roles.
2562
+ */
2563
+ RolesKey?: RolesKey;
2564
+ /**
2565
+ * Element of the JWT assertion used by the cluster to verify JWT signatures.
2566
+ */
2567
+ PublicKey?: String;
2568
+ }
2569
+ export interface JWTOptionsOutput {
2570
+ /**
2571
+ * True if JWT use is enabled.
2572
+ */
2573
+ Enabled?: Boolean;
2574
+ /**
2575
+ * The key used for matching the JWT subject attribute.
2576
+ */
2577
+ SubjectKey?: String;
2578
+ /**
2579
+ * The key used for matching the JWT roles attribute.
2580
+ */
2581
+ RolesKey?: String;
2582
+ /**
2583
+ * The key used to verify the signature of incoming JWT requests.
2584
+ */
2585
+ PublicKey?: String;
2586
+ }
2543
2587
  export type KmsKeyId = string;
2544
2588
  export type LastUpdated = Date;
2545
2589
  export type LimitName = string;
@@ -3276,6 +3320,7 @@ declare namespace OpenSearch {
3276
3320
  export interface RevokeVpcEndpointAccessResponse {
3277
3321
  }
3278
3322
  export type RoleArn = string;
3323
+ export type RolesKey = string;
3279
3324
  export type RollbackOnDisable = "NO_ROLLBACK"|"DEFAULT_ROLLBACK"|string;
3280
3325
  export type S3BucketName = string;
3281
3326
  export interface S3GlueDataCatalog {
@@ -3553,6 +3598,7 @@ declare namespace OpenSearch {
3553
3598
  export type StorageTypeName = string;
3554
3599
  export type String = string;
3555
3600
  export type StringList = String[];
3601
+ export type SubjectKey = string;
3556
3602
  export type TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|"Policy-Min-TLS-1-2-PFS-2023-10"|string;
3557
3603
  export interface Tag {
3558
3604
  /**
@@ -3589,7 +3635,7 @@ declare namespace OpenSearch {
3589
3635
  */
3590
3636
  Description?: DataSourceDescription;
3591
3637
  /**
3592
- * The status of the data source update request.
3638
+ * The status of the data source update.
3593
3639
  */
3594
3640
  Status?: DataSourceStatus;
3595
3641
  }