aws-sdk-bedrock 1.46.0 → 1.52.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.
@@ -23,6 +23,25 @@ module Aws::Bedrock
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # Information about the agreement availability
27
+ #
28
+ # @!attribute [rw] status
29
+ # Status of the agreement.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] error_message
33
+ # Error message.
34
+ # @return [String]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AgreementAvailability AWS API Documentation
37
+ #
38
+ class AgreementAvailability < Struct.new(
39
+ :status,
40
+ :error_message)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
26
45
  # The configuration details of an automated evaluation job. The
27
46
  # `EvaluationDatasetMetricConfig` object is used to specify the prompt
28
47
  # datasets, task type, and metric names.
@@ -264,6 +283,97 @@ module Aws::Bedrock
264
283
  include Aws::Structure
265
284
  end
266
285
 
286
+ # @!attribute [rw] model_name
287
+ # A unique name for the custom model.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] model_source_config
291
+ # The data source for the model. The Amazon S3 URI in the model source
292
+ # must be for the Amazon-managed Amazon S3 bucket containing your
293
+ # model artifacts.
294
+ # @return [Types::ModelDataSource]
295
+ #
296
+ # @!attribute [rw] model_kms_key_arn
297
+ # The Amazon Resource Name (ARN) of the customer managed KMS key to
298
+ # encrypt the custom model. If you don't provide a KMS key, Amazon
299
+ # Bedrock uses an Amazon Web Services-managed KMS key to encrypt the
300
+ # model.
301
+ #
302
+ # If you provide a customer managed KMS key, your Amazon Bedrock
303
+ # service role must have permissions to use it. For more information
304
+ # see [Encryption of imported models][1].
305
+ #
306
+ #
307
+ #
308
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] role_arn
312
+ # The Amazon Resource Name (ARN) of an IAM service role that Amazon
313
+ # Bedrock assumes to perform tasks on your behalf. This role must have
314
+ # permissions to access the Amazon S3 bucket containing your model
315
+ # artifacts and the KMS key (if specified). For more information, see
316
+ # [Setting up an IAM service role for importing models][1] in the
317
+ # Amazon Bedrock User Guide.
318
+ #
319
+ #
320
+ #
321
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] model_tags
325
+ # A list of key-value pairs to associate with the custom model
326
+ # resource. You can use these tags to organize and identify your
327
+ # resources.
328
+ #
329
+ # For more information, see [Tagging resources][1] in the [Amazon
330
+ # Bedrock User Guide][2].
331
+ #
332
+ #
333
+ #
334
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
335
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
336
+ # @return [Array<Types::Tag>]
337
+ #
338
+ # @!attribute [rw] client_request_token
339
+ # A unique, case-sensitive identifier to ensure that the API request
340
+ # completes no more than one time. If this token matches a previous
341
+ # request, Amazon Bedrock ignores the request, but does not return an
342
+ # error. For more information, see [Ensuring idempotency][1].
343
+ #
344
+ # **A suitable default value is auto-generated.** You should normally
345
+ # not need to pass this option.
346
+ #
347
+ #
348
+ #
349
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
350
+ # @return [String]
351
+ #
352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelRequest AWS API Documentation
353
+ #
354
+ class CreateCustomModelRequest < Struct.new(
355
+ :model_name,
356
+ :model_source_config,
357
+ :model_kms_key_arn,
358
+ :role_arn,
359
+ :model_tags,
360
+ :client_request_token)
361
+ SENSITIVE = []
362
+ include Aws::Structure
363
+ end
364
+
365
+ # @!attribute [rw] model_arn
366
+ # The Amazon Resource Name (ARN) of the new custom model.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelResponse AWS API Documentation
370
+ #
371
+ class CreateCustomModelResponse < Struct.new(
372
+ :model_arn)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
267
377
  # @!attribute [rw] job_name
268
378
  # A name for the evaluation job. Names must unique with your Amazon
269
379
  # Web Services account, and your account's Amazon Web Services
@@ -365,6 +475,35 @@ module Aws::Bedrock
365
475
  include Aws::Structure
366
476
  end
367
477
 
478
+ # @!attribute [rw] offer_token
479
+ # An offer token encapsulates the information for an offer.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] model_id
483
+ # Model Id of the model for the access request.
484
+ # @return [String]
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementRequest AWS API Documentation
487
+ #
488
+ class CreateFoundationModelAgreementRequest < Struct.new(
489
+ :offer_token,
490
+ :model_id)
491
+ SENSITIVE = []
492
+ include Aws::Structure
493
+ end
494
+
495
+ # @!attribute [rw] model_id
496
+ # Model Id of the model for the access request.
497
+ # @return [String]
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementResponse AWS API Documentation
500
+ #
501
+ class CreateFoundationModelAgreementResponse < Struct.new(
502
+ :model_id)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
368
507
  # @!attribute [rw] name
369
508
  # The name to give the guardrail.
370
509
  # @return [String]
@@ -1301,6 +1440,17 @@ module Aws::Bedrock
1301
1440
  # The unique identifier of the account that owns the model.
1302
1441
  # @return [String]
1303
1442
  #
1443
+ # @!attribute [rw] model_status
1444
+ # The current status of the custom model. Possible values include:
1445
+ #
1446
+ # * `Creating` - The model is being created and validated.
1447
+ #
1448
+ # * `Active` - The model has been successfully created and is ready
1449
+ # for use.
1450
+ #
1451
+ # * `Failed` - The model creation process failed.
1452
+ # @return [String]
1453
+ #
1304
1454
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation
1305
1455
  #
1306
1456
  class CustomModelSummary < Struct.new(
@@ -1310,7 +1460,8 @@ module Aws::Bedrock
1310
1460
  :base_model_arn,
1311
1461
  :base_model_name,
1312
1462
  :customization_type,
1313
- :owner_account_id)
1463
+ :owner_account_id,
1464
+ :model_status)
1314
1465
  SENSITIVE = []
1315
1466
  include Aws::Structure
1316
1467
  end
@@ -1408,6 +1559,22 @@ module Aws::Bedrock
1408
1559
  #
1409
1560
  class DeleteCustomModelResponse < Aws::EmptyStructure; end
1410
1561
 
1562
+ # @!attribute [rw] model_id
1563
+ # Model Id of the model access to delete.
1564
+ # @return [String]
1565
+ #
1566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementRequest AWS API Documentation
1567
+ #
1568
+ class DeleteFoundationModelAgreementRequest < Struct.new(
1569
+ :model_id)
1570
+ SENSITIVE = []
1571
+ include Aws::Structure
1572
+ end
1573
+
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementResponse AWS API Documentation
1575
+ #
1576
+ class DeleteFoundationModelAgreementResponse < Aws::EmptyStructure; end
1577
+
1411
1578
  # @!attribute [rw] guardrail_identifier
1412
1579
  # The unique identifier of the guardrail. This can be an ID or the
1413
1580
  # ARN.
@@ -1539,6 +1706,35 @@ module Aws::Bedrock
1539
1706
  #
1540
1707
  class DeregisterMarketplaceModelEndpointResponse < Aws::EmptyStructure; end
1541
1708
 
1709
+ # Dimensional price rate.
1710
+ #
1711
+ # @!attribute [rw] dimension
1712
+ # Dimension for the price rate.
1713
+ # @return [String]
1714
+ #
1715
+ # @!attribute [rw] price
1716
+ # Single-dimensional rate information.
1717
+ # @return [String]
1718
+ #
1719
+ # @!attribute [rw] description
1720
+ # Description of the price rate.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] unit
1724
+ # Unit associated with the price.
1725
+ # @return [String]
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DimensionalPriceRate AWS API Documentation
1728
+ #
1729
+ class DimensionalPriceRate < Struct.new(
1730
+ :dimension,
1731
+ :price,
1732
+ :description,
1733
+ :unit)
1734
+ SENSITIVE = []
1735
+ include Aws::Structure
1736
+ end
1737
+
1542
1738
  # Settings for distilling a foundation model into a smaller and more
1543
1739
  # efficient model.
1544
1740
  #
@@ -2408,7 +2604,13 @@ module Aws::Bedrock
2408
2604
  # @return [String]
2409
2605
  #
2410
2606
  # @!attribute [rw] job_arn
2411
- # Job Amazon Resource Name (ARN) associated with this model.
2607
+ # Job Amazon Resource Name (ARN) associated with this model. For
2608
+ # models that you create with the [CreateCustomModel][1] API
2609
+ # operation, this is `NULL`.
2610
+ #
2611
+ #
2612
+ #
2613
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html
2412
2614
  # @return [String]
2413
2615
  #
2414
2616
  # @!attribute [rw] base_model_arn
@@ -2460,6 +2662,24 @@ module Aws::Bedrock
2460
2662
  # The customization configuration for the custom model.
2461
2663
  # @return [Types::CustomizationConfig]
2462
2664
  #
2665
+ # @!attribute [rw] model_status
2666
+ # The current status of the custom model. Possible values include:
2667
+ #
2668
+ # * `Creating` - The model is being created and validated.
2669
+ #
2670
+ # * `Active` - The model has been successfully created and is ready
2671
+ # for use.
2672
+ #
2673
+ # * `Failed` - The model creation process failed. Check the
2674
+ # `failureMessage` field for details.
2675
+ # @return [String]
2676
+ #
2677
+ # @!attribute [rw] failure_message
2678
+ # A failure message for any issues that occurred when creating the
2679
+ # custom model. This is included for only a failed CreateCustomModel
2680
+ # operation.
2681
+ # @return [String]
2682
+ #
2463
2683
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelResponse AWS API Documentation
2464
2684
  #
2465
2685
  class GetCustomModelResponse < Struct.new(
@@ -2477,7 +2697,9 @@ module Aws::Bedrock
2477
2697
  :training_metrics,
2478
2698
  :validation_metrics,
2479
2699
  :creation_time,
2480
- :customization_config)
2700
+ :customization_config,
2701
+ :model_status,
2702
+ :failure_message)
2481
2703
  SENSITIVE = []
2482
2704
  include Aws::Structure
2483
2705
  end
@@ -2579,6 +2801,50 @@ module Aws::Bedrock
2579
2801
  include Aws::Structure
2580
2802
  end
2581
2803
 
2804
+ # @!attribute [rw] model_id
2805
+ # The model Id of the foundation model.
2806
+ # @return [String]
2807
+ #
2808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityRequest AWS API Documentation
2809
+ #
2810
+ class GetFoundationModelAvailabilityRequest < Struct.new(
2811
+ :model_id)
2812
+ SENSITIVE = []
2813
+ include Aws::Structure
2814
+ end
2815
+
2816
+ # @!attribute [rw] model_id
2817
+ # The model Id of the foundation model.
2818
+ # @return [String]
2819
+ #
2820
+ # @!attribute [rw] agreement_availability
2821
+ # Agreement availability.
2822
+ # @return [Types::AgreementAvailability]
2823
+ #
2824
+ # @!attribute [rw] authorization_status
2825
+ # Authorization status.
2826
+ # @return [String]
2827
+ #
2828
+ # @!attribute [rw] entitlement_availability
2829
+ # Entitlement availability.
2830
+ # @return [String]
2831
+ #
2832
+ # @!attribute [rw] region_availability
2833
+ # Region availability.
2834
+ # @return [String]
2835
+ #
2836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityResponse AWS API Documentation
2837
+ #
2838
+ class GetFoundationModelAvailabilityResponse < Struct.new(
2839
+ :model_id,
2840
+ :agreement_availability,
2841
+ :authorization_status,
2842
+ :entitlement_availability,
2843
+ :region_availability)
2844
+ SENSITIVE = []
2845
+ include Aws::Structure
2846
+ end
2847
+
2582
2848
  # @!attribute [rw] model_identifier
2583
2849
  # The model identifier.
2584
2850
  # @return [String]
@@ -3020,15 +3286,15 @@ module Aws::Bedrock
3020
3286
  # failed.
3021
3287
  # @return [String]
3022
3288
  #
3023
- # @!attribute [rw] failure_message
3024
- # Information about why the job failed.
3025
- # @return [String]
3026
- #
3027
3289
  # @!attribute [rw] status_details
3028
3290
  # For a Distillation job, the details about the statuses of the
3029
3291
  # sub-tasks of the customization job.
3030
3292
  # @return [Types::StatusDetails]
3031
3293
  #
3294
+ # @!attribute [rw] failure_message
3295
+ # Information about why the job failed.
3296
+ # @return [String]
3297
+ #
3032
3298
  # @!attribute [rw] creation_time
3033
3299
  # Time that the resource was created.
3034
3300
  # @return [Time]
@@ -3101,8 +3367,8 @@ module Aws::Bedrock
3101
3367
  :client_request_token,
3102
3368
  :role_arn,
3103
3369
  :status,
3104
- :failure_message,
3105
3370
  :status_details,
3371
+ :failure_message,
3106
3372
  :creation_time,
3107
3373
  :last_modified_time,
3108
3374
  :end_time,
@@ -3558,6 +3824,24 @@ module Aws::Bedrock
3558
3824
  include Aws::Structure
3559
3825
  end
3560
3826
 
3827
+ # @api private
3828
+ #
3829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessRequest AWS API Documentation
3830
+ #
3831
+ class GetUseCaseForModelAccessRequest < Aws::EmptyStructure; end
3832
+
3833
+ # @!attribute [rw] form_data
3834
+ # Get customer profile Response.
3835
+ # @return [String]
3836
+ #
3837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessResponse AWS API Documentation
3838
+ #
3839
+ class GetUseCaseForModelAccessResponse < Struct.new(
3840
+ :form_data)
3841
+ SENSITIVE = []
3842
+ include Aws::Structure
3843
+ end
3844
+
3561
3845
  # The configuration details for the guardrail.
3562
3846
  #
3563
3847
  # @!attribute [rw] guardrail_id
@@ -3812,6 +4096,60 @@ module Aws::Bedrock
3812
4096
  include Aws::Structure
3813
4097
  end
3814
4098
 
4099
+ # The tier that your guardrail uses for content filters.
4100
+ #
4101
+ # @!attribute [rw] tier_name
4102
+ # The tier that your guardrail uses for content filters. Valid values
4103
+ # include:
4104
+ #
4105
+ # * `CLASSIC` tier – Provides established guardrails functionality
4106
+ # supporting English, French, and Spanish languages.
4107
+ #
4108
+ # * `STANDARD` tier – Provides a more robust solution than the
4109
+ # `CLASSIC` tier and has more comprehensive language support. This
4110
+ # tier requires that your guardrail use [cross-Region inference][1].
4111
+ #
4112
+ #
4113
+ #
4114
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4115
+ # @return [String]
4116
+ #
4117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTier AWS API Documentation
4118
+ #
4119
+ class GuardrailContentFiltersTier < Struct.new(
4120
+ :tier_name)
4121
+ SENSITIVE = [:tier_name]
4122
+ include Aws::Structure
4123
+ end
4124
+
4125
+ # The tier that your guardrail uses for content filters. Consider using
4126
+ # a tier that balances performance, accuracy, and compatibility with
4127
+ # your existing generative AI workflows.
4128
+ #
4129
+ # @!attribute [rw] tier_name
4130
+ # The tier that your guardrail uses for content filters. Valid values
4131
+ # include:
4132
+ #
4133
+ # * `CLASSIC` tier – Provides established guardrails functionality
4134
+ # supporting English, French, and Spanish languages.
4135
+ #
4136
+ # * `STANDARD` tier – Provides a more robust solution than the
4137
+ # `CLASSIC` tier and has more comprehensive language support. This
4138
+ # tier requires that your guardrail use [cross-Region inference][1].
4139
+ #
4140
+ #
4141
+ #
4142
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4143
+ # @return [String]
4144
+ #
4145
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTierConfig AWS API Documentation
4146
+ #
4147
+ class GuardrailContentFiltersTierConfig < Struct.new(
4148
+ :tier_name)
4149
+ SENSITIVE = [:tier_name]
4150
+ include Aws::Structure
4151
+ end
4152
+
3815
4153
  # Contains details about how to handle harmful content.
3816
4154
  #
3817
4155
  # This data type is used in the following API operations:
@@ -3829,10 +4167,15 @@ module Aws::Bedrock
3829
4167
  # apply to prompts and model responses.
3830
4168
  # @return [Array<Types::GuardrailContentFilter>]
3831
4169
  #
4170
+ # @!attribute [rw] tier
4171
+ # The tier that your guardrail uses for content filters.
4172
+ # @return [Types::GuardrailContentFiltersTier]
4173
+ #
3832
4174
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicy AWS API Documentation
3833
4175
  #
3834
4176
  class GuardrailContentPolicy < Struct.new(
3835
- :filters)
4177
+ :filters,
4178
+ :tier)
3836
4179
  SENSITIVE = []
3837
4180
  include Aws::Structure
3838
4181
  end
@@ -3844,10 +4187,15 @@ module Aws::Bedrock
3844
4187
  # apply to prompts and model responses.
3845
4188
  # @return [Array<Types::GuardrailContentFilterConfig>]
3846
4189
  #
4190
+ # @!attribute [rw] tier_config
4191
+ # The tier that your guardrail uses for content filters.
4192
+ # @return [Types::GuardrailContentFiltersTierConfig]
4193
+ #
3847
4194
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicyConfig AWS API Documentation
3848
4195
  #
3849
4196
  class GuardrailContentPolicyConfig < Struct.new(
3850
- :filters_config)
4197
+ :filters_config,
4198
+ :tier_config)
3851
4199
  SENSITIVE = []
3852
4200
  include Aws::Structure
3853
4201
  end
@@ -4865,10 +5213,15 @@ module Aws::Bedrock
4865
5213
  # A list of policies related to topics that the guardrail should deny.
4866
5214
  # @return [Array<Types::GuardrailTopic>]
4867
5215
  #
5216
+ # @!attribute [rw] tier
5217
+ # The tier that your guardrail uses for denied topic filters.
5218
+ # @return [Types::GuardrailTopicsTier]
5219
+ #
4868
5220
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicy AWS API Documentation
4869
5221
  #
4870
5222
  class GuardrailTopicPolicy < Struct.new(
4871
- :topics)
5223
+ :topics,
5224
+ :tier)
4872
5225
  SENSITIVE = []
4873
5226
  include Aws::Structure
4874
5227
  end
@@ -4880,14 +5233,73 @@ module Aws::Bedrock
4880
5233
  # A list of policies related to topics that the guardrail should deny.
4881
5234
  # @return [Array<Types::GuardrailTopicConfig>]
4882
5235
  #
5236
+ # @!attribute [rw] tier_config
5237
+ # The tier that your guardrail uses for denied topic filters.
5238
+ # @return [Types::GuardrailTopicsTierConfig]
5239
+ #
4883
5240
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicyConfig AWS API Documentation
4884
5241
  #
4885
5242
  class GuardrailTopicPolicyConfig < Struct.new(
4886
- :topics_config)
5243
+ :topics_config,
5244
+ :tier_config)
4887
5245
  SENSITIVE = []
4888
5246
  include Aws::Structure
4889
5247
  end
4890
5248
 
5249
+ # The tier that your guardrail uses for denied topic filters.
5250
+ #
5251
+ # @!attribute [rw] tier_name
5252
+ # The tier that your guardrail uses for denied topic filters. Valid
5253
+ # values include:
5254
+ #
5255
+ # * `CLASSIC` tier – Provides established guardrails functionality
5256
+ # supporting English, French, and Spanish languages.
5257
+ #
5258
+ # * `STANDARD` tier – Provides a more robust solution than the
5259
+ # `CLASSIC` tier and has more comprehensive language support. This
5260
+ # tier requires that your guardrail use [cross-Region inference][1].
5261
+ #
5262
+ #
5263
+ #
5264
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5265
+ # @return [String]
5266
+ #
5267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTier AWS API Documentation
5268
+ #
5269
+ class GuardrailTopicsTier < Struct.new(
5270
+ :tier_name)
5271
+ SENSITIVE = [:tier_name]
5272
+ include Aws::Structure
5273
+ end
5274
+
5275
+ # The tier that your guardrail uses for denied topic filters. Consider
5276
+ # using a tier that balances performance, accuracy, and compatibility
5277
+ # with your existing generative AI workflows.
5278
+ #
5279
+ # @!attribute [rw] tier_name
5280
+ # The tier that your guardrail uses for denied topic filters. Valid
5281
+ # values include:
5282
+ #
5283
+ # * `CLASSIC` tier – Provides established guardrails functionality
5284
+ # supporting English, French, and Spanish languages.
5285
+ #
5286
+ # * `STANDARD` tier – Provides a more robust solution than the
5287
+ # `CLASSIC` tier and has more comprehensive language support. This
5288
+ # tier requires that your guardrail use [cross-Region inference][1].
5289
+ #
5290
+ #
5291
+ #
5292
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5293
+ # @return [String]
5294
+ #
5295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTierConfig AWS API Documentation
5296
+ #
5297
+ class GuardrailTopicsTierConfig < Struct.new(
5298
+ :tier_name)
5299
+ SENSITIVE = [:tier_name]
5300
+ include Aws::Structure
5301
+ end
5302
+
4891
5303
  # A word configured for the guardrail.
4892
5304
  #
4893
5305
  # @!attribute [rw] text
@@ -5458,6 +5870,20 @@ module Aws::Bedrock
5458
5870
  include Aws::Structure
5459
5871
  end
5460
5872
 
5873
+ # The legal term of the agreement.
5874
+ #
5875
+ # @!attribute [rw] url
5876
+ # URL to the legal term document.
5877
+ # @return [String]
5878
+ #
5879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
5880
+ #
5881
+ class LegalTerm < Struct.new(
5882
+ :url)
5883
+ SENSITIVE = []
5884
+ include Aws::Structure
5885
+ end
5886
+
5461
5887
  # @!attribute [rw] creation_time_before
5462
5888
  # Return custom models created before the specified time.
5463
5889
  # @return [Time]
@@ -5507,6 +5933,22 @@ module Aws::Bedrock
5507
5933
  # (`true`) or if they were shared with the current account (`false`).
5508
5934
  # @return [Boolean]
5509
5935
  #
5936
+ # @!attribute [rw] model_status
5937
+ # The status of them model to filter results by. Possible values
5938
+ # include:
5939
+ #
5940
+ # * `Creating` - Include only models that are currently being created
5941
+ # and validated.
5942
+ #
5943
+ # * `Active` - Include only models that have been successfully created
5944
+ # and are ready for use.
5945
+ #
5946
+ # * `Failed` - Include only models where the creation process failed.
5947
+ #
5948
+ # If you don't specify a status, the API returns models in all
5949
+ # states.
5950
+ # @return [String]
5951
+ #
5510
5952
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation
5511
5953
  #
5512
5954
  class ListCustomModelsRequest < Struct.new(
@@ -5519,7 +5961,8 @@ module Aws::Bedrock
5519
5961
  :next_token,
5520
5962
  :sort_by,
5521
5963
  :sort_order,
5522
- :is_owned)
5964
+ :is_owned,
5965
+ :model_status)
5523
5966
  SENSITIVE = []
5524
5967
  include Aws::Structure
5525
5968
  end
@@ -5621,6 +6064,40 @@ module Aws::Bedrock
5621
6064
  include Aws::Structure
5622
6065
  end
5623
6066
 
6067
+ # @!attribute [rw] model_id
6068
+ # Model Id of the foundation model.
6069
+ # @return [String]
6070
+ #
6071
+ # @!attribute [rw] offer_type
6072
+ # Type of offer associated with the model.
6073
+ # @return [String]
6074
+ #
6075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersRequest AWS API Documentation
6076
+ #
6077
+ class ListFoundationModelAgreementOffersRequest < Struct.new(
6078
+ :model_id,
6079
+ :offer_type)
6080
+ SENSITIVE = []
6081
+ include Aws::Structure
6082
+ end
6083
+
6084
+ # @!attribute [rw] model_id
6085
+ # Model Id of the foundation model.
6086
+ # @return [String]
6087
+ #
6088
+ # @!attribute [rw] offers
6089
+ # List of the offers associated with the specified model.
6090
+ # @return [Array<Types::Offer>]
6091
+ #
6092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersResponse AWS API Documentation
6093
+ #
6094
+ class ListFoundationModelAgreementOffersResponse < Struct.new(
6095
+ :model_id,
6096
+ :offers)
6097
+ SENSITIVE = []
6098
+ include Aws::Structure
6099
+ end
6100
+
5624
6101
  # @!attribute [rw] by_provider
5625
6102
  # Return models belonging to the model provider that you specify.
5626
6103
  # @return [String]
@@ -6638,14 +7115,14 @@ module Aws::Bedrock
6638
7115
  # Status of the customization job.
6639
7116
  # @return [String]
6640
7117
  #
6641
- # @!attribute [rw] last_modified_time
6642
- # Time that the customization job was last modified.
6643
- # @return [Time]
6644
- #
6645
7118
  # @!attribute [rw] status_details
6646
7119
  # Details about the status of the data processing sub-task of the job.
6647
7120
  # @return [Types::StatusDetails]
6648
7121
  #
7122
+ # @!attribute [rw] last_modified_time
7123
+ # Time that the customization job was last modified.
7124
+ # @return [Time]
7125
+ #
6649
7126
  # @!attribute [rw] creation_time
6650
7127
  # Creation time of the custom model.
6651
7128
  # @return [Time]
@@ -6679,8 +7156,8 @@ module Aws::Bedrock
6679
7156
  :base_model_arn,
6680
7157
  :job_name,
6681
7158
  :status,
6682
- :last_modified_time,
6683
7159
  :status_details,
7160
+ :last_modified_time,
6684
7161
  :creation_time,
6685
7162
  :end_time,
6686
7163
  :custom_model_arn,
@@ -6690,14 +7167,14 @@ module Aws::Bedrock
6690
7167
  include Aws::Structure
6691
7168
  end
6692
7169
 
6693
- # Data source for the imported model.
7170
+ # The data source of the model to import.
6694
7171
  #
6695
7172
  # @note ModelDataSource is a union - when making an API calls you must set exactly one of the members.
6696
7173
  #
6697
7174
  # @note ModelDataSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ModelDataSource corresponding to the set member.
6698
7175
  #
6699
7176
  # @!attribute [rw] s3_data_source
6700
- # The Amazon S3 data source of the imported model.
7177
+ # The Amazon S3 data source of the model to import.
6701
7178
  # @return [Types::S3DataSource]
6702
7179
  #
6703
7180
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelDataSource AWS API Documentation
@@ -7015,6 +7492,30 @@ module Aws::Bedrock
7015
7492
  include Aws::Structure
7016
7493
  end
7017
7494
 
7495
+ # An offer dictates usage terms for the model.
7496
+ #
7497
+ # @!attribute [rw] offer_id
7498
+ # Offer Id for a model offer.
7499
+ # @return [String]
7500
+ #
7501
+ # @!attribute [rw] offer_token
7502
+ # Offer token.
7503
+ # @return [String]
7504
+ #
7505
+ # @!attribute [rw] term_details
7506
+ # Details about the terms of the offer.
7507
+ # @return [Types::TermDetails]
7508
+ #
7509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Offer AWS API Documentation
7510
+ #
7511
+ class Offer < Struct.new(
7512
+ :offer_id,
7513
+ :offer_token,
7514
+ :term_details)
7515
+ SENSITIVE = []
7516
+ include Aws::Structure
7517
+ end
7518
+
7018
7519
  # The configuration details for the model to process the prompt prior to
7019
7520
  # retrieval and response generation.
7020
7521
  #
@@ -7059,6 +7560,20 @@ module Aws::Bedrock
7059
7560
  include Aws::Structure
7060
7561
  end
7061
7562
 
7563
+ # Describes the usage-based pricing term.
7564
+ #
7565
+ # @!attribute [rw] rate_card
7566
+ # Describes a usage price for each dimension.
7567
+ # @return [Array<Types::DimensionalPriceRate>]
7568
+ #
7569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PricingTerm AWS API Documentation
7570
+ #
7571
+ class PricingTerm < Struct.new(
7572
+ :rate_card)
7573
+ SENSITIVE = []
7574
+ include Aws::Structure
7575
+ end
7576
+
7062
7577
  # Details about a prompt router.
7063
7578
  #
7064
7579
  # @!attribute [rw] prompt_router_name
@@ -7262,6 +7777,22 @@ module Aws::Bedrock
7262
7777
  #
7263
7778
  class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
7264
7779
 
7780
+ # @!attribute [rw] form_data
7781
+ # Put customer profile Request.
7782
+ # @return [String]
7783
+ #
7784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessRequest AWS API Documentation
7785
+ #
7786
+ class PutUseCaseForModelAccessRequest < Struct.new(
7787
+ :form_data)
7788
+ SENSITIVE = []
7789
+ include Aws::Structure
7790
+ end
7791
+
7792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessResponse AWS API Documentation
7793
+ #
7794
+ class PutUseCaseForModelAccessResponse < Aws::EmptyStructure; end
7795
+
7265
7796
  # The configuration details for transforming the prompt.
7266
7797
  #
7267
7798
  # @!attribute [rw] type
@@ -7727,7 +8258,7 @@ module Aws::Bedrock
7727
8258
  include Aws::Structure
7728
8259
  end
7729
8260
 
7730
- # The Amazon S3 data source of the imported job.
8261
+ # The Amazon S3 data source of the model to import.
7731
8262
  #
7732
8263
  # @!attribute [rw] s3_uri
7733
8264
  # The URI of the Amazon S3 data source.
@@ -7908,6 +8439,20 @@ module Aws::Bedrock
7908
8439
  #
7909
8440
  class StopModelInvocationJobResponse < Aws::EmptyStructure; end
7910
8441
 
8442
+ # Describes a support term.
8443
+ #
8444
+ # @!attribute [rw] refund_policy_description
8445
+ # Describes the refund policy.
8446
+ # @return [String]
8447
+ #
8448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/SupportTerm AWS API Documentation
8449
+ #
8450
+ class SupportTerm < Struct.new(
8451
+ :refund_policy_description)
8452
+ SENSITIVE = []
8453
+ include Aws::Structure
8454
+ end
8455
+
7911
8456
  # Definition of the key/value pair for a tag.
7912
8457
  #
7913
8458
  # @!attribute [rw] key
@@ -7968,6 +8513,35 @@ module Aws::Bedrock
7968
8513
  include Aws::Structure
7969
8514
  end
7970
8515
 
8516
+ # Describes the usage terms of an offer.
8517
+ #
8518
+ # @!attribute [rw] usage_based_pricing_term
8519
+ # Describes the usage-based pricing term.
8520
+ # @return [Types::PricingTerm]
8521
+ #
8522
+ # @!attribute [rw] legal_term
8523
+ # Describes the legal terms.
8524
+ # @return [Types::LegalTerm]
8525
+ #
8526
+ # @!attribute [rw] support_term
8527
+ # Describes the support terms.
8528
+ # @return [Types::SupportTerm]
8529
+ #
8530
+ # @!attribute [rw] validity_term
8531
+ # Describes the validity terms.
8532
+ # @return [Types::ValidityTerm]
8533
+ #
8534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TermDetails AWS API Documentation
8535
+ #
8536
+ class TermDetails < Struct.new(
8537
+ :usage_based_pricing_term,
8538
+ :legal_term,
8539
+ :support_term,
8540
+ :validity_term)
8541
+ SENSITIVE = []
8542
+ include Aws::Structure
8543
+ end
8544
+
7971
8545
  # The configuration details for text generation using a language model
7972
8546
  # via the `RetrieveAndGenerate` function.
7973
8547
  #
@@ -8390,6 +8964,20 @@ module Aws::Bedrock
8390
8964
  include Aws::Structure
8391
8965
  end
8392
8966
 
8967
+ # Describes the validity terms.
8968
+ #
8969
+ # @!attribute [rw] agreement_duration
8970
+ # Describes the agreement duration.
8971
+ # @return [String]
8972
+ #
8973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidityTerm AWS API Documentation
8974
+ #
8975
+ class ValidityTerm < Struct.new(
8976
+ :agreement_duration)
8977
+ SENSITIVE = []
8978
+ include Aws::Structure
8979
+ end
8980
+
8393
8981
  # The configuration of a virtual private cloud (VPC). For more
8394
8982
  # information, see [Protect your data using Amazon Virtual Private Cloud
8395
8983
  # and Amazon Web Services PrivateLink][1].