aws-sdk-bedrock 1.46.0 → 1.56.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.
@@ -35,6 +35,7 @@ require 'aws-sdk-core/plugins/recursion_detection'
35
35
  require 'aws-sdk-core/plugins/telemetry'
36
36
  require 'aws-sdk-core/plugins/sign'
37
37
  require 'aws-sdk-core/plugins/protocols/rest_json'
38
+ require 'aws-sdk-bedrock/plugins/bearer_authorization'
38
39
 
39
40
  module Aws::Bedrock
40
41
  # An API client for Bedrock. To construct a client, you need to configure a `:region` and `:credentials`.
@@ -85,6 +86,7 @@ module Aws::Bedrock
85
86
  add_plugin(Aws::Plugins::Telemetry)
86
87
  add_plugin(Aws::Plugins::Sign)
87
88
  add_plugin(Aws::Plugins::Protocols::RestJson)
89
+ add_plugin(Aws::Bedrock::Plugins::BearerAuthorization)
88
90
  add_plugin(Aws::Bedrock::Plugins::Endpoints)
89
91
 
90
92
  # @overload initialize(options)
@@ -95,7 +97,7 @@ module Aws::Bedrock
95
97
  # class name or an instance of a plugin class.
96
98
  #
97
99
  # @option options [required, Aws::CredentialProvider] :credentials
98
- # Your AWS credentials. This can be an instance of any one of the
100
+ # Your AWS credentials used for authentication. This can be an instance of any one of the
99
101
  # following classes:
100
102
  #
101
103
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
@@ -128,18 +130,23 @@ module Aws::Bedrock
128
130
  # locations will be searched for credentials:
129
131
  #
130
132
  # * `Aws.config[:credentials]`
133
+ #
131
134
  # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
135
  # `:account_id` options.
133
- # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
- # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
136
+ #
137
+ # * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
138
+ # `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
139
+ #
135
140
  # * `~/.aws/credentials`
141
+ #
136
142
  # * `~/.aws/config`
143
+ #
137
144
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
145
  # are very aggressive. Construct and pass an instance of
139
146
  # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
147
  # enable retries and extended timeouts. Instance profile credential
141
- # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
- # to true.
148
+ # fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
149
+ # to `true`.
143
150
  #
144
151
  # @option options [required, String] :region
145
152
  # The AWS region to connect to. The configured `:region` is
@@ -167,6 +174,11 @@ module Aws::Bedrock
167
174
  # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
175
  # not retry instead of sleeping.
169
176
  #
177
+ # @option options [Array<String>] :auth_scheme_preference
178
+ # A list of preferred authentication schemes to use when making a request. Supported values are:
179
+ # `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
180
+ # shared config as `auth_scheme_preference`, the value should be a comma-separated list.
181
+ #
170
182
  # @option options [Boolean] :client_side_monitoring (false)
171
183
  # When `true`, client-side metrics will be collected for all API requests from
172
184
  # this client.
@@ -253,8 +265,8 @@ module Aws::Bedrock
253
265
  # 4 times. Used in `standard` and `adaptive` retry modes.
254
266
  #
255
267
  # @option options [String] :profile ("default")
256
- # Used when loading credentials from the shared credentials file
257
- # at HOME/.aws/credentials. When not specified, 'default' is used.
268
+ # Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
269
+ # When not specified, 'default' is used.
258
270
  #
259
271
  # @option options [String] :request_checksum_calculation ("when_supported")
260
272
  # Determines when a checksum will be calculated for request payloads. Values are:
@@ -367,7 +379,7 @@ module Aws::Bedrock
367
379
  # `Aws::Telemetry::OTelProvider` for telemetry provider.
368
380
  #
369
381
  # @option options [Aws::TokenProvider] :token_provider
370
- # A Bearer Token Provider. This can be an instance of any one of the
382
+ # Your Bearer token used for authentication. This can be an instance of any one of the
371
383
  # following classes:
372
384
  #
373
385
  # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
@@ -537,6 +549,252 @@ module Aws::Bedrock
537
549
  req.send_request(options)
538
550
  end
539
551
 
552
+ # Creates a new custom model in Amazon Bedrock. After the model is
553
+ # active, you can use it for inference.
554
+ #
555
+ # To use the model for inference, you must purchase Provisioned
556
+ # Throughput for it. You can't use On-demand inference with these
557
+ # custom models. For more information about Provisioned Throughput, see
558
+ # [Provisioned Throughput][1].
559
+ #
560
+ # The model appears in `ListCustomModels` with a `customizationType` of
561
+ # `imported`. To track the status of the new model, you use the
562
+ # `GetCustomModel` API operation. The model can be in the following
563
+ # states:
564
+ #
565
+ # * `Creating` - Initial state during validation and registration
566
+ #
567
+ # * `Active` - Model is ready for use in inference
568
+ #
569
+ # * `Failed` - Creation process encountered an error
570
+ #
571
+ # **Related APIs**
572
+ #
573
+ # * [GetCustomModel][2]
574
+ #
575
+ # * [ListCustomModels][3]
576
+ #
577
+ # * [DeleteCustomModel][4]
578
+ #
579
+ #
580
+ #
581
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html
582
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModel.html
583
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModels.html
584
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModel.html
585
+ #
586
+ # @option params [required, String] :model_name
587
+ # A unique name for the custom model.
588
+ #
589
+ # @option params [required, Types::ModelDataSource] :model_source_config
590
+ # The data source for the model. The Amazon S3 URI in the model source
591
+ # must be for the Amazon-managed Amazon S3 bucket containing your model
592
+ # artifacts.
593
+ #
594
+ # @option params [String] :model_kms_key_arn
595
+ # The Amazon Resource Name (ARN) of the customer managed KMS key to
596
+ # encrypt the custom model. If you don't provide a KMS key, Amazon
597
+ # Bedrock uses an Amazon Web Services-managed KMS key to encrypt the
598
+ # model.
599
+ #
600
+ # If you provide a customer managed KMS key, your Amazon Bedrock service
601
+ # role must have permissions to use it. For more information see
602
+ # [Encryption of imported models][1].
603
+ #
604
+ #
605
+ #
606
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html
607
+ #
608
+ # @option params [String] :role_arn
609
+ # The Amazon Resource Name (ARN) of an IAM service role that Amazon
610
+ # Bedrock assumes to perform tasks on your behalf. This role must have
611
+ # permissions to access the Amazon S3 bucket containing your model
612
+ # artifacts and the KMS key (if specified). For more information, see
613
+ # [Setting up an IAM service role for importing models][1] in the Amazon
614
+ # Bedrock User Guide.
615
+ #
616
+ #
617
+ #
618
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html
619
+ #
620
+ # @option params [Array<Types::Tag>] :model_tags
621
+ # A list of key-value pairs to associate with the custom model resource.
622
+ # You can use these tags to organize and identify your resources.
623
+ #
624
+ # For more information, see [Tagging resources][1] in the [Amazon
625
+ # Bedrock User Guide][2].
626
+ #
627
+ #
628
+ #
629
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
630
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
631
+ #
632
+ # @option params [String] :client_request_token
633
+ # A unique, case-sensitive identifier to ensure that the API request
634
+ # completes no more than one time. If this token matches a previous
635
+ # request, Amazon Bedrock ignores the request, but does not return an
636
+ # error. For more information, see [Ensuring idempotency][1].
637
+ #
638
+ # **A suitable default value is auto-generated.** You should normally
639
+ # not need to pass this option.**
640
+ #
641
+ #
642
+ #
643
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
644
+ #
645
+ # @return [Types::CreateCustomModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
646
+ #
647
+ # * {Types::CreateCustomModelResponse#model_arn #model_arn} => String
648
+ #
649
+ #
650
+ # @example Example: Successful CreateCustomModel API call
651
+ #
652
+ # resp = client.create_custom_model({
653
+ # client_request_token: "foo",
654
+ # model_kms_key_arn: "arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
655
+ # model_name: "SampleModel",
656
+ # model_source_config: {
657
+ # s3_data_source: {
658
+ # s3_uri: "s3://my-bucket/folder",
659
+ # },
660
+ # },
661
+ # model_tags: [
662
+ # {
663
+ # key: "foo",
664
+ # value: "foo",
665
+ # },
666
+ # {
667
+ # key: "foo",
668
+ # value: "foo",
669
+ # },
670
+ # ],
671
+ # role_arn: "arn:aws:iam::123456789012:role/SampleRole",
672
+ # })
673
+ #
674
+ # resp.to_h outputs the following:
675
+ # {
676
+ # model_arn: "arn:aws:bedrock:us-east-1:123456789012:custom-model/imported/abcdef123456",
677
+ # }
678
+ #
679
+ # @example Request syntax with placeholder values
680
+ #
681
+ # resp = client.create_custom_model({
682
+ # model_name: "CustomModelName", # required
683
+ # model_source_config: { # required
684
+ # s3_data_source: {
685
+ # s3_uri: "S3Uri", # required
686
+ # },
687
+ # },
688
+ # model_kms_key_arn: "KmsKeyArn",
689
+ # role_arn: "RoleArn",
690
+ # model_tags: [
691
+ # {
692
+ # key: "TagKey", # required
693
+ # value: "TagValue", # required
694
+ # },
695
+ # ],
696
+ # client_request_token: "IdempotencyToken",
697
+ # })
698
+ #
699
+ # @example Response structure
700
+ #
701
+ # resp.model_arn #=> String
702
+ #
703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModel AWS API Documentation
704
+ #
705
+ # @overload create_custom_model(params = {})
706
+ # @param [Hash] params ({})
707
+ def create_custom_model(params = {}, options = {})
708
+ req = build_request(:create_custom_model, params)
709
+ req.send_request(options)
710
+ end
711
+
712
+ # Deploys a custom model for on-demand inference in Amazon Bedrock.
713
+ # After you deploy your custom model, you use the deployment's Amazon
714
+ # Resource Name (ARN) as the `modelId` parameter when you submit prompts
715
+ # and generate responses with model inference.
716
+ #
717
+ # For more information about setting up on-demand inference for custom
718
+ # models, see [Set up inference for a custom model][1].
719
+ #
720
+ # The following actions are related to the `CreateCustomModelDeployment`
721
+ # operation:
722
+ #
723
+ # * [GetCustomModelDeployment][2]
724
+ #
725
+ # * [ListCustomModelDeployments][3]
726
+ #
727
+ # * [DeleteCustomModelDeployment][4]
728
+ #
729
+ #
730
+ #
731
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html
732
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html
733
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html
734
+ # [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html
735
+ #
736
+ # @option params [required, String] :model_deployment_name
737
+ # The name for the custom model deployment. The name must be unique
738
+ # within your Amazon Web Services account and Region.
739
+ #
740
+ # @option params [required, String] :model_arn
741
+ # The Amazon Resource Name (ARN) of the custom model to deploy for
742
+ # on-demand inference. The custom model must be in the `Active` state.
743
+ #
744
+ # @option params [String] :description
745
+ # A description for the custom model deployment to help you identify its
746
+ # purpose.
747
+ #
748
+ # @option params [Array<Types::Tag>] :tags
749
+ # Tags to assign to the custom model deployment. You can use tags to
750
+ # organize and track your Amazon Web Services resources for cost
751
+ # allocation and management purposes.
752
+ #
753
+ # @option params [String] :client_request_token
754
+ # A unique, case-sensitive identifier to ensure that the operation
755
+ # completes no more than one time. If this token matches a previous
756
+ # request, Amazon Bedrock ignores the request, but does not return an
757
+ # error. For more information, see [Ensuring idempotency][1].
758
+ #
759
+ # **A suitable default value is auto-generated.** You should normally
760
+ # not need to pass this option.**
761
+ #
762
+ #
763
+ #
764
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-idempotency.html
765
+ #
766
+ # @return [Types::CreateCustomModelDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
767
+ #
768
+ # * {Types::CreateCustomModelDeploymentResponse#custom_model_deployment_arn #custom_model_deployment_arn} => String
769
+ #
770
+ # @example Request syntax with placeholder values
771
+ #
772
+ # resp = client.create_custom_model_deployment({
773
+ # model_deployment_name: "ModelDeploymentName", # required
774
+ # model_arn: "CustomModelArn", # required
775
+ # description: "CustomModelDeploymentDescription",
776
+ # tags: [
777
+ # {
778
+ # key: "TagKey", # required
779
+ # value: "TagValue", # required
780
+ # },
781
+ # ],
782
+ # client_request_token: "IdempotencyToken",
783
+ # })
784
+ #
785
+ # @example Response structure
786
+ #
787
+ # resp.custom_model_deployment_arn #=> String
788
+ #
789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelDeployment AWS API Documentation
790
+ #
791
+ # @overload create_custom_model_deployment(params = {})
792
+ # @param [Hash] params ({})
793
+ def create_custom_model_deployment(params = {}, options = {})
794
+ req = build_request(:create_custom_model_deployment, params)
795
+ req.send_request(options)
796
+ end
797
+
540
798
  # Creates an evaluation job.
541
799
  #
542
800
  # @option params [required, String] :job_name
@@ -784,6 +1042,44 @@ module Aws::Bedrock
784
1042
  # },
785
1043
  # ],
786
1044
  # },
1045
+ # implicit_filter_configuration: {
1046
+ # metadata_attributes: [ # required
1047
+ # {
1048
+ # key: "MetadataAttributeSchemaKeyString", # required
1049
+ # type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
1050
+ # description: "MetadataAttributeSchemaDescriptionString", # required
1051
+ # },
1052
+ # ],
1053
+ # model_arn: "BedrockModelArn", # required
1054
+ # },
1055
+ # reranking_configuration: {
1056
+ # type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
1057
+ # bedrock_reranking_configuration: {
1058
+ # model_configuration: { # required
1059
+ # model_arn: "BedrockRerankingModelArn", # required
1060
+ # additional_model_request_fields: {
1061
+ # "AdditionalModelRequestFieldsKey" => {
1062
+ # },
1063
+ # },
1064
+ # },
1065
+ # number_of_reranked_results: 1,
1066
+ # metadata_configuration: {
1067
+ # selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
1068
+ # selective_mode_configuration: {
1069
+ # fields_to_include: [
1070
+ # {
1071
+ # field_name: "FieldForRerankingFieldNameString", # required
1072
+ # },
1073
+ # ],
1074
+ # fields_to_exclude: [
1075
+ # {
1076
+ # field_name: "FieldForRerankingFieldNameString", # required
1077
+ # },
1078
+ # ],
1079
+ # },
1080
+ # },
1081
+ # },
1082
+ # },
787
1083
  # },
788
1084
  # },
789
1085
  # },
@@ -863,6 +1159,44 @@ module Aws::Bedrock
863
1159
  # },
864
1160
  # ],
865
1161
  # },
1162
+ # implicit_filter_configuration: {
1163
+ # metadata_attributes: [ # required
1164
+ # {
1165
+ # key: "MetadataAttributeSchemaKeyString", # required
1166
+ # type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
1167
+ # description: "MetadataAttributeSchemaDescriptionString", # required
1168
+ # },
1169
+ # ],
1170
+ # model_arn: "BedrockModelArn", # required
1171
+ # },
1172
+ # reranking_configuration: {
1173
+ # type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
1174
+ # bedrock_reranking_configuration: {
1175
+ # model_configuration: { # required
1176
+ # model_arn: "BedrockRerankingModelArn", # required
1177
+ # additional_model_request_fields: {
1178
+ # "AdditionalModelRequestFieldsKey" => {
1179
+ # },
1180
+ # },
1181
+ # },
1182
+ # number_of_reranked_results: 1,
1183
+ # metadata_configuration: {
1184
+ # selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
1185
+ # selective_mode_configuration: {
1186
+ # fields_to_include: [
1187
+ # {
1188
+ # field_name: "FieldForRerankingFieldNameString", # required
1189
+ # },
1190
+ # ],
1191
+ # fields_to_exclude: [
1192
+ # {
1193
+ # field_name: "FieldForRerankingFieldNameString", # required
1194
+ # },
1195
+ # ],
1196
+ # },
1197
+ # },
1198
+ # },
1199
+ # },
866
1200
  # },
867
1201
  # },
868
1202
  # generation_configuration: {
@@ -960,6 +1294,38 @@ module Aws::Bedrock
960
1294
  req.send_request(options)
961
1295
  end
962
1296
 
1297
+ # Request a model access agreement for the specified model.
1298
+ #
1299
+ # @option params [required, String] :offer_token
1300
+ # An offer token encapsulates the information for an offer.
1301
+ #
1302
+ # @option params [required, String] :model_id
1303
+ # Model Id of the model for the access request.
1304
+ #
1305
+ # @return [Types::CreateFoundationModelAgreementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1306
+ #
1307
+ # * {Types::CreateFoundationModelAgreementResponse#model_id #model_id} => String
1308
+ #
1309
+ # @example Request syntax with placeholder values
1310
+ #
1311
+ # resp = client.create_foundation_model_agreement({
1312
+ # offer_token: "OfferToken", # required
1313
+ # model_id: "BedrockModelId", # required
1314
+ # })
1315
+ #
1316
+ # @example Response structure
1317
+ #
1318
+ # resp.model_id #=> String
1319
+ #
1320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreement AWS API Documentation
1321
+ #
1322
+ # @overload create_foundation_model_agreement(params = {})
1323
+ # @param [Hash] params ({})
1324
+ def create_foundation_model_agreement(params = {}, options = {})
1325
+ req = build_request(:create_foundation_model_agreement, params)
1326
+ req.send_request(options)
1327
+ end
1328
+
963
1329
  # Creates a guardrail to block topics and to implement safeguards for
964
1330
  # your generative AI applications.
965
1331
  #
@@ -1078,6 +1444,9 @@ module Aws::Bedrock
1078
1444
  # output_enabled: false,
1079
1445
  # },
1080
1446
  # ],
1447
+ # tier_config: {
1448
+ # tier_name: "CLASSIC", # required, accepts CLASSIC, STANDARD
1449
+ # },
1081
1450
  # },
1082
1451
  # content_policy_config: {
1083
1452
  # filters_config: [ # required
@@ -1093,6 +1462,9 @@ module Aws::Bedrock
1093
1462
  # output_enabled: false,
1094
1463
  # },
1095
1464
  # ],
1465
+ # tier_config: {
1466
+ # tier_name: "CLASSIC", # required, accepts CLASSIC, STANDARD
1467
+ # },
1096
1468
  # },
1097
1469
  # word_policy_config: {
1098
1470
  # words_config: [
@@ -1585,7 +1957,7 @@ module Aws::Bedrock
1585
1957
  # role_arn: "RoleArn", # required
1586
1958
  # client_request_token: "IdempotencyToken",
1587
1959
  # base_model_identifier: "BaseModelIdentifier", # required
1588
- # customization_type: "FINE_TUNING", # accepts FINE_TUNING, CONTINUED_PRE_TRAINING, DISTILLATION
1960
+ # customization_type: "FINE_TUNING", # accepts FINE_TUNING, CONTINUED_PRE_TRAINING, DISTILLATION, IMPORTED
1589
1961
  # custom_model_kms_key_id: "KmsKeyId",
1590
1962
  # job_tags: [
1591
1963
  # {
@@ -2103,6 +2475,68 @@ module Aws::Bedrock
2103
2475
  req.send_request(options)
2104
2476
  end
2105
2477
 
2478
+ # Deletes a custom model deployment. This operation stops the deployment
2479
+ # and removes it from your account. After deletion, the deployment ARN
2480
+ # can no longer be used for inference requests.
2481
+ #
2482
+ # The following actions are related to the `DeleteCustomModelDeployment`
2483
+ # operation:
2484
+ #
2485
+ # * [CreateCustomModelDeployment][1]
2486
+ #
2487
+ # * [GetCustomModelDeployment][2]
2488
+ #
2489
+ # * [ListCustomModelDeployments][3]
2490
+ #
2491
+ #
2492
+ #
2493
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html
2494
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html
2495
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html
2496
+ #
2497
+ # @option params [required, String] :custom_model_deployment_identifier
2498
+ # The Amazon Resource Name (ARN) or name of the custom model deployment
2499
+ # to delete.
2500
+ #
2501
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2502
+ #
2503
+ # @example Request syntax with placeholder values
2504
+ #
2505
+ # resp = client.delete_custom_model_deployment({
2506
+ # custom_model_deployment_identifier: "CustomModelDeploymentIdentifier", # required
2507
+ # })
2508
+ #
2509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelDeployment AWS API Documentation
2510
+ #
2511
+ # @overload delete_custom_model_deployment(params = {})
2512
+ # @param [Hash] params ({})
2513
+ def delete_custom_model_deployment(params = {}, options = {})
2514
+ req = build_request(:delete_custom_model_deployment, params)
2515
+ req.send_request(options)
2516
+ end
2517
+
2518
+ # Delete the model access agreement for the specified model.
2519
+ #
2520
+ # @option params [required, String] :model_id
2521
+ # Model Id of the model access to delete.
2522
+ #
2523
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2524
+ #
2525
+ # @example Request syntax with placeholder values
2526
+ #
2527
+ # resp = client.delete_foundation_model_agreement({
2528
+ # model_id: "BedrockModelId", # required
2529
+ # })
2530
+ #
2531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreement AWS API Documentation
2532
+ #
2533
+ # @overload delete_foundation_model_agreement(params = {})
2534
+ # @param [Hash] params ({})
2535
+ def delete_foundation_model_agreement(params = {}, options = {})
2536
+ req = build_request(:delete_foundation_model_agreement, params)
2537
+ req.send_request(options)
2538
+ end
2539
+
2106
2540
  # Deletes a guardrail.
2107
2541
  #
2108
2542
  # * To delete a guardrail, only specify the ARN of the guardrail in the
@@ -2306,7 +2740,7 @@ module Aws::Bedrock
2306
2740
  end
2307
2741
 
2308
2742
  # Get the properties associated with a Amazon Bedrock custom model that
2309
- # you have created.For more information, see [Custom models][1] in the
2743
+ # you have created. For more information, see [Custom models][1] in the
2310
2744
  # [Amazon Bedrock User Guide][2].
2311
2745
  #
2312
2746
  #
@@ -2334,6 +2768,8 @@ module Aws::Bedrock
2334
2768
  # * {Types::GetCustomModelResponse#validation_metrics #validation_metrics} => Array&lt;Types::ValidatorMetric&gt;
2335
2769
  # * {Types::GetCustomModelResponse#creation_time #creation_time} => Time
2336
2770
  # * {Types::GetCustomModelResponse#customization_config #customization_config} => Types::CustomizationConfig
2771
+ # * {Types::GetCustomModelResponse#model_status #model_status} => String
2772
+ # * {Types::GetCustomModelResponse#failure_message #failure_message} => String
2337
2773
  #
2338
2774
  # @example Request syntax with placeholder values
2339
2775
  #
@@ -2348,7 +2784,7 @@ module Aws::Bedrock
2348
2784
  # resp.job_name #=> String
2349
2785
  # resp.job_arn #=> String
2350
2786
  # resp.base_model_arn #=> String
2351
- # resp.customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION"
2787
+ # resp.customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION", "IMPORTED"
2352
2788
  # resp.model_kms_key_arn #=> String
2353
2789
  # resp.hyper_parameters #=> Hash
2354
2790
  # resp.hyper_parameters["String"] #=> String
@@ -2378,6 +2814,8 @@ module Aws::Bedrock
2378
2814
  # resp.creation_time #=> Time
2379
2815
  # resp.customization_config.distillation_config.teacher_model_config.teacher_model_identifier #=> String
2380
2816
  # resp.customization_config.distillation_config.teacher_model_config.max_response_length_for_inference #=> Integer
2817
+ # resp.model_status #=> String, one of "Active", "Creating", "Failed"
2818
+ # resp.failure_message #=> String
2381
2819
  #
2382
2820
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModel AWS API Documentation
2383
2821
  #
@@ -2388,6 +2826,66 @@ module Aws::Bedrock
2388
2826
  req.send_request(options)
2389
2827
  end
2390
2828
 
2829
+ # Retrieves information about a custom model deployment, including its
2830
+ # status, configuration, and metadata. Use this operation to monitor the
2831
+ # deployment status and retrieve details needed for inference requests.
2832
+ #
2833
+ # The following actions are related to the `GetCustomModelDeployment`
2834
+ # operation:
2835
+ #
2836
+ # * [CreateCustomModelDeployment][1]
2837
+ #
2838
+ # * [ListCustomModelDeployments][2]
2839
+ #
2840
+ # * [DeleteCustomModelDeployment][3]
2841
+ #
2842
+ #
2843
+ #
2844
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html
2845
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html
2846
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html
2847
+ #
2848
+ # @option params [required, String] :custom_model_deployment_identifier
2849
+ # The Amazon Resource Name (ARN) or name of the custom model deployment
2850
+ # to retrieve information about.
2851
+ #
2852
+ # @return [Types::GetCustomModelDeploymentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2853
+ #
2854
+ # * {Types::GetCustomModelDeploymentResponse#custom_model_deployment_arn #custom_model_deployment_arn} => String
2855
+ # * {Types::GetCustomModelDeploymentResponse#model_deployment_name #model_deployment_name} => String
2856
+ # * {Types::GetCustomModelDeploymentResponse#model_arn #model_arn} => String
2857
+ # * {Types::GetCustomModelDeploymentResponse#created_at #created_at} => Time
2858
+ # * {Types::GetCustomModelDeploymentResponse#status #status} => String
2859
+ # * {Types::GetCustomModelDeploymentResponse#description #description} => String
2860
+ # * {Types::GetCustomModelDeploymentResponse#failure_message #failure_message} => String
2861
+ # * {Types::GetCustomModelDeploymentResponse#last_updated_at #last_updated_at} => Time
2862
+ #
2863
+ # @example Request syntax with placeholder values
2864
+ #
2865
+ # resp = client.get_custom_model_deployment({
2866
+ # custom_model_deployment_identifier: "CustomModelDeploymentIdentifier", # required
2867
+ # })
2868
+ #
2869
+ # @example Response structure
2870
+ #
2871
+ # resp.custom_model_deployment_arn #=> String
2872
+ # resp.model_deployment_name #=> String
2873
+ # resp.model_arn #=> String
2874
+ # resp.created_at #=> Time
2875
+ # resp.status #=> String, one of "Creating", "Active", "Failed"
2876
+ # resp.description #=> String
2877
+ # resp.failure_message #=> String
2878
+ # resp.last_updated_at #=> Time
2879
+ #
2880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelDeployment AWS API Documentation
2881
+ #
2882
+ # @overload get_custom_model_deployment(params = {})
2883
+ # @param [Hash] params ({})
2884
+ def get_custom_model_deployment(params = {}, options = {})
2885
+ req = build_request(:get_custom_model_deployment, params)
2886
+ req.send_request(options)
2887
+ end
2888
+
2391
2889
  # Gets information about an evaluation job, such as the status of the
2392
2890
  # job.
2393
2891
  #
@@ -2481,6 +2979,20 @@ module Aws::Bedrock
2481
2979
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.and_all[0] #=> Types::RetrievalFilter
2482
2980
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.or_all #=> Array
2483
2981
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.or_all[0] #=> Types::RetrievalFilter
2982
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes #=> Array
2983
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].key #=> String
2984
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].type #=> String, one of "STRING", "NUMBER", "BOOLEAN", "STRING_LIST"
2985
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].description #=> String
2986
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.model_arn #=> String
2987
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.type #=> String, one of "BEDROCK_RERANKING_MODEL"
2988
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.model_arn #=> String
2989
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.additional_model_request_fields #=> Hash
2990
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.number_of_reranked_results #=> Integer
2991
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selection_mode #=> String, one of "SELECTIVE", "ALL"
2992
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include #=> Array
2993
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include[0].field_name #=> String
2994
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude #=> Array
2995
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude[0].field_name #=> String
2484
2996
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.type #=> String, one of "KNOWLEDGE_BASE", "EXTERNAL_SOURCES"
2485
2997
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.knowledge_base_id #=> String
2486
2998
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.model_arn #=> String
@@ -2501,6 +3013,20 @@ module Aws::Bedrock
2501
3013
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.and_all[0] #=> Types::RetrievalFilter
2502
3014
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.or_all #=> Array
2503
3015
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.or_all[0] #=> Types::RetrievalFilter
3016
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes #=> Array
3017
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].key #=> String
3018
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].type #=> String, one of "STRING", "NUMBER", "BOOLEAN", "STRING_LIST"
3019
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].description #=> String
3020
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.model_arn #=> String
3021
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.type #=> String, one of "BEDROCK_RERANKING_MODEL"
3022
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.model_arn #=> String
3023
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.additional_model_request_fields #=> Hash
3024
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.number_of_reranked_results #=> Integer
3025
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selection_mode #=> String, one of "SELECTIVE", "ALL"
3026
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include #=> Array
3027
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include[0].field_name #=> String
3028
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude #=> Array
3029
+ # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude[0].field_name #=> String
2504
3030
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.prompt_template.text_prompt_template #=> String
2505
3031
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.guardrail_configuration.guardrail_id #=> String
2506
3032
  # resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.guardrail_configuration.guardrail_version #=> String
@@ -2585,6 +3111,43 @@ module Aws::Bedrock
2585
3111
  req.send_request(options)
2586
3112
  end
2587
3113
 
3114
+ # Get information about the Foundation model availability.
3115
+ #
3116
+ # @option params [required, String] :model_id
3117
+ # The model Id of the foundation model.
3118
+ #
3119
+ # @return [Types::GetFoundationModelAvailabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3120
+ #
3121
+ # * {Types::GetFoundationModelAvailabilityResponse#model_id #model_id} => String
3122
+ # * {Types::GetFoundationModelAvailabilityResponse#agreement_availability #agreement_availability} => Types::AgreementAvailability
3123
+ # * {Types::GetFoundationModelAvailabilityResponse#authorization_status #authorization_status} => String
3124
+ # * {Types::GetFoundationModelAvailabilityResponse#entitlement_availability #entitlement_availability} => String
3125
+ # * {Types::GetFoundationModelAvailabilityResponse#region_availability #region_availability} => String
3126
+ #
3127
+ # @example Request syntax with placeholder values
3128
+ #
3129
+ # resp = client.get_foundation_model_availability({
3130
+ # model_id: "BedrockModelId", # required
3131
+ # })
3132
+ #
3133
+ # @example Response structure
3134
+ #
3135
+ # resp.model_id #=> String
3136
+ # resp.agreement_availability.status #=> String, one of "AVAILABLE", "PENDING", "NOT_AVAILABLE", "ERROR"
3137
+ # resp.agreement_availability.error_message #=> String
3138
+ # resp.authorization_status #=> String, one of "AUTHORIZED", "NOT_AUTHORIZED"
3139
+ # resp.entitlement_availability #=> String, one of "AVAILABLE", "NOT_AVAILABLE"
3140
+ # resp.region_availability #=> String, one of "AVAILABLE", "NOT_AVAILABLE"
3141
+ #
3142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailability AWS API Documentation
3143
+ #
3144
+ # @overload get_foundation_model_availability(params = {})
3145
+ # @param [Hash] params ({})
3146
+ def get_foundation_model_availability(params = {}, options = {})
3147
+ req = build_request(:get_foundation_model_availability, params)
3148
+ req.send_request(options)
3149
+ end
3150
+
2588
3151
  # Gets details about a guardrail. If you don't specify a version, the
2589
3152
  # response returns details for the `DRAFT` version.
2590
3153
  #
@@ -2644,6 +3207,7 @@ module Aws::Bedrock
2644
3207
  # resp.topic_policy.topics[0].output_action #=> String, one of "BLOCK", "NONE"
2645
3208
  # resp.topic_policy.topics[0].input_enabled #=> Boolean
2646
3209
  # resp.topic_policy.topics[0].output_enabled #=> Boolean
3210
+ # resp.topic_policy.tier.tier_name #=> String, one of "CLASSIC", "STANDARD"
2647
3211
  # resp.content_policy.filters #=> Array
2648
3212
  # resp.content_policy.filters[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
2649
3213
  # resp.content_policy.filters[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
@@ -2656,6 +3220,7 @@ module Aws::Bedrock
2656
3220
  # resp.content_policy.filters[0].output_action #=> String, one of "BLOCK", "NONE"
2657
3221
  # resp.content_policy.filters[0].input_enabled #=> Boolean
2658
3222
  # resp.content_policy.filters[0].output_enabled #=> Boolean
3223
+ # resp.content_policy.tier.tier_name #=> String, one of "CLASSIC", "STANDARD"
2659
3224
  # resp.word_policy.words #=> Array
2660
3225
  # resp.word_policy.words[0].text #=> String
2661
3226
  # resp.word_policy.words[0].input_action #=> String, one of "BLOCK", "NONE"
@@ -2931,8 +3496,8 @@ module Aws::Bedrock
2931
3496
  # * {Types::GetModelCustomizationJobResponse#client_request_token #client_request_token} => String
2932
3497
  # * {Types::GetModelCustomizationJobResponse#role_arn #role_arn} => String
2933
3498
  # * {Types::GetModelCustomizationJobResponse#status #status} => String
2934
- # * {Types::GetModelCustomizationJobResponse#failure_message #failure_message} => String
2935
3499
  # * {Types::GetModelCustomizationJobResponse#status_details #status_details} => Types::StatusDetails
3500
+ # * {Types::GetModelCustomizationJobResponse#failure_message #failure_message} => String
2936
3501
  # * {Types::GetModelCustomizationJobResponse#creation_time #creation_time} => Time
2937
3502
  # * {Types::GetModelCustomizationJobResponse#last_modified_time #last_modified_time} => Time
2938
3503
  # * {Types::GetModelCustomizationJobResponse#end_time #end_time} => Time
@@ -2963,7 +3528,6 @@ module Aws::Bedrock
2963
3528
  # resp.client_request_token #=> String
2964
3529
  # resp.role_arn #=> String
2965
3530
  # resp.status #=> String, one of "InProgress", "Completed", "Failed", "Stopping", "Stopped"
2966
- # resp.failure_message #=> String
2967
3531
  # resp.status_details.validation_details.status #=> String, one of "InProgress", "Completed", "Stopping", "Stopped", "Failed", "NotStarted"
2968
3532
  # resp.status_details.validation_details.creation_time #=> Time
2969
3533
  # resp.status_details.validation_details.last_modified_time #=> Time
@@ -2973,6 +3537,7 @@ module Aws::Bedrock
2973
3537
  # resp.status_details.training_details.status #=> String, one of "InProgress", "Completed", "Stopping", "Stopped", "Failed", "NotStarted"
2974
3538
  # resp.status_details.training_details.creation_time #=> Time
2975
3539
  # resp.status_details.training_details.last_modified_time #=> Time
3540
+ # resp.failure_message #=> String
2976
3541
  # resp.creation_time #=> Time
2977
3542
  # resp.last_modified_time #=> Time
2978
3543
  # resp.end_time #=> Time
@@ -2999,7 +3564,7 @@ module Aws::Bedrock
2999
3564
  # resp.validation_data_config.validators #=> Array
3000
3565
  # resp.validation_data_config.validators[0].s3_uri #=> String
3001
3566
  # resp.output_data_config.s3_uri #=> String
3002
- # resp.customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION"
3567
+ # resp.customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION", "IMPORTED"
3003
3568
  # resp.output_model_kms_key_arn #=> String
3004
3569
  # resp.training_metrics.training_loss #=> Float
3005
3570
  # resp.validation_metrics #=> Array
@@ -3283,6 +3848,121 @@ module Aws::Bedrock
3283
3848
  req.send_request(options)
3284
3849
  end
3285
3850
 
3851
+ # Get usecase for model access.
3852
+ #
3853
+ # @return [Types::GetUseCaseForModelAccessResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3854
+ #
3855
+ # * {Types::GetUseCaseForModelAccessResponse#form_data #form_data} => String
3856
+ #
3857
+ # @example Response structure
3858
+ #
3859
+ # resp.form_data #=> String
3860
+ #
3861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccess AWS API Documentation
3862
+ #
3863
+ # @overload get_use_case_for_model_access(params = {})
3864
+ # @param [Hash] params ({})
3865
+ def get_use_case_for_model_access(params = {}, options = {})
3866
+ req = build_request(:get_use_case_for_model_access, params)
3867
+ req.send_request(options)
3868
+ end
3869
+
3870
+ # Lists custom model deployments in your account. You can filter the
3871
+ # results by creation time, name, status, and associated model. Use this
3872
+ # operation to manage and monitor your custom model deployments.
3873
+ #
3874
+ # We recommend using pagination to ensure that the operation returns
3875
+ # quickly and successfully.
3876
+ #
3877
+ # The following actions are related to the `ListCustomModelDeployments`
3878
+ # operation:
3879
+ #
3880
+ # * [CreateCustomModelDeployment][1]
3881
+ #
3882
+ # * [GetCustomModelDeployment][2]
3883
+ #
3884
+ # * [DeleteCustomModelDeployment][3]
3885
+ #
3886
+ #
3887
+ #
3888
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html
3889
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html
3890
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html
3891
+ #
3892
+ # @option params [Time,DateTime,Date,Integer,String] :created_before
3893
+ # Filters deployments created before the specified date and time.
3894
+ #
3895
+ # @option params [Time,DateTime,Date,Integer,String] :created_after
3896
+ # Filters deployments created after the specified date and time.
3897
+ #
3898
+ # @option params [String] :name_contains
3899
+ # Filters deployments whose names contain the specified string.
3900
+ #
3901
+ # @option params [Integer] :max_results
3902
+ # The maximum number of results to return in a single call.
3903
+ #
3904
+ # @option params [String] :next_token
3905
+ # The token for the next set of results. Use this token to retrieve
3906
+ # additional results when the response is truncated.
3907
+ #
3908
+ # @option params [String] :sort_by
3909
+ # The field to sort the results by. The only supported value is
3910
+ # `CreationTime`.
3911
+ #
3912
+ # @option params [String] :sort_order
3913
+ # The sort order for the results. Valid values are `Ascending` and
3914
+ # `Descending`. Default is `Descending`.
3915
+ #
3916
+ # @option params [String] :status_equals
3917
+ # Filters deployments by status. Valid values are `CREATING`, `ACTIVE`,
3918
+ # and `FAILED`.
3919
+ #
3920
+ # @option params [String] :model_arn_equals
3921
+ # Filters deployments by the Amazon Resource Name (ARN) of the
3922
+ # associated custom model.
3923
+ #
3924
+ # @return [Types::ListCustomModelDeploymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3925
+ #
3926
+ # * {Types::ListCustomModelDeploymentsResponse#next_token #next_token} => String
3927
+ # * {Types::ListCustomModelDeploymentsResponse#model_deployment_summaries #model_deployment_summaries} => Array&lt;Types::CustomModelDeploymentSummary&gt;
3928
+ #
3929
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3930
+ #
3931
+ # @example Request syntax with placeholder values
3932
+ #
3933
+ # resp = client.list_custom_model_deployments({
3934
+ # created_before: Time.now,
3935
+ # created_after: Time.now,
3936
+ # name_contains: "ModelDeploymentName",
3937
+ # max_results: 1,
3938
+ # next_token: "PaginationToken",
3939
+ # sort_by: "CreationTime", # accepts CreationTime
3940
+ # sort_order: "Ascending", # accepts Ascending, Descending
3941
+ # status_equals: "Creating", # accepts Creating, Active, Failed
3942
+ # model_arn_equals: "CustomModelArn",
3943
+ # })
3944
+ #
3945
+ # @example Response structure
3946
+ #
3947
+ # resp.next_token #=> String
3948
+ # resp.model_deployment_summaries #=> Array
3949
+ # resp.model_deployment_summaries[0].custom_model_deployment_arn #=> String
3950
+ # resp.model_deployment_summaries[0].custom_model_deployment_name #=> String
3951
+ # resp.model_deployment_summaries[0].model_arn #=> String
3952
+ # resp.model_deployment_summaries[0].created_at #=> Time
3953
+ # resp.model_deployment_summaries[0].status #=> String, one of "Creating", "Active", "Failed"
3954
+ # resp.model_deployment_summaries[0].last_updated_at #=> Time
3955
+ # resp.model_deployment_summaries[0].failure_message #=> String
3956
+ #
3957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelDeployments AWS API Documentation
3958
+ #
3959
+ # @overload list_custom_model_deployments(params = {})
3960
+ # @param [Hash] params ({})
3961
+ def list_custom_model_deployments(params = {}, options = {})
3962
+ req = build_request(:list_custom_model_deployments, params)
3963
+ req.send_request(options)
3964
+ end
3965
+
3286
3966
  # Returns a list of the custom models that you have created with the
3287
3967
  # `CreateModelCustomizationJob` operation.
3288
3968
  #
@@ -3333,6 +4013,20 @@ module Aws::Bedrock
3333
4013
  # Return custom models depending on if the current account owns them
3334
4014
  # (`true`) or if they were shared with the current account (`false`).
3335
4015
  #
4016
+ # @option params [String] :model_status
4017
+ # The status of them model to filter results by. Possible values
4018
+ # include:
4019
+ #
4020
+ # * `Creating` - Include only models that are currently being created
4021
+ # and validated.
4022
+ #
4023
+ # * `Active` - Include only models that have been successfully created
4024
+ # and are ready for use.
4025
+ #
4026
+ # * `Failed` - Include only models where the creation process failed.
4027
+ #
4028
+ # If you don't specify a status, the API returns models in all states.
4029
+ #
3336
4030
  # @return [Types::ListCustomModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3337
4031
  #
3338
4032
  # * {Types::ListCustomModelsResponse#next_token #next_token} => String
@@ -3353,6 +4047,7 @@ module Aws::Bedrock
3353
4047
  # sort_by: "CreationTime", # accepts CreationTime
3354
4048
  # sort_order: "Ascending", # accepts Ascending, Descending
3355
4049
  # is_owned: false,
4050
+ # model_status: "Active", # accepts Active, Creating, Failed
3356
4051
  # })
3357
4052
  #
3358
4053
  # @example Response structure
@@ -3364,8 +4059,9 @@ module Aws::Bedrock
3364
4059
  # resp.model_summaries[0].creation_time #=> Time
3365
4060
  # resp.model_summaries[0].base_model_arn #=> String
3366
4061
  # resp.model_summaries[0].base_model_name #=> String
3367
- # resp.model_summaries[0].customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION"
4062
+ # resp.model_summaries[0].customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION", "IMPORTED"
3368
4063
  # resp.model_summaries[0].owner_account_id #=> String
4064
+ # resp.model_summaries[0].model_status #=> String, one of "Active", "Creating", "Failed"
3369
4065
  #
3370
4066
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModels AWS API Documentation
3371
4067
  #
@@ -3469,6 +4165,50 @@ module Aws::Bedrock
3469
4165
  req.send_request(options)
3470
4166
  end
3471
4167
 
4168
+ # Get the offers associated with the specified model.
4169
+ #
4170
+ # @option params [required, String] :model_id
4171
+ # Model Id of the foundation model.
4172
+ #
4173
+ # @option params [String] :offer_type
4174
+ # Type of offer associated with the model.
4175
+ #
4176
+ # @return [Types::ListFoundationModelAgreementOffersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4177
+ #
4178
+ # * {Types::ListFoundationModelAgreementOffersResponse#model_id #model_id} => String
4179
+ # * {Types::ListFoundationModelAgreementOffersResponse#offers #offers} => Array&lt;Types::Offer&gt;
4180
+ #
4181
+ # @example Request syntax with placeholder values
4182
+ #
4183
+ # resp = client.list_foundation_model_agreement_offers({
4184
+ # model_id: "BedrockModelId", # required
4185
+ # offer_type: "ALL", # accepts ALL, PUBLIC
4186
+ # })
4187
+ #
4188
+ # @example Response structure
4189
+ #
4190
+ # resp.model_id #=> String
4191
+ # resp.offers #=> Array
4192
+ # resp.offers[0].offer_id #=> String
4193
+ # resp.offers[0].offer_token #=> String
4194
+ # resp.offers[0].term_details.usage_based_pricing_term.rate_card #=> Array
4195
+ # resp.offers[0].term_details.usage_based_pricing_term.rate_card[0].dimension #=> String
4196
+ # resp.offers[0].term_details.usage_based_pricing_term.rate_card[0].price #=> String
4197
+ # resp.offers[0].term_details.usage_based_pricing_term.rate_card[0].description #=> String
4198
+ # resp.offers[0].term_details.usage_based_pricing_term.rate_card[0].unit #=> String
4199
+ # resp.offers[0].term_details.legal_term.url #=> String
4200
+ # resp.offers[0].term_details.support_term.refund_policy_description #=> String
4201
+ # resp.offers[0].term_details.validity_term.agreement_duration #=> String
4202
+ #
4203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffers AWS API Documentation
4204
+ #
4205
+ # @overload list_foundation_model_agreement_offers(params = {})
4206
+ # @param [Hash] params ({})
4207
+ def list_foundation_model_agreement_offers(params = {}, options = {})
4208
+ req = build_request(:list_foundation_model_agreement_offers, params)
4209
+ req.send_request(options)
4210
+ end
4211
+
3472
4212
  # Lists Amazon Bedrock foundation models that you can use. You can
3473
4213
  # filter the results with the request parameters. For more information,
3474
4214
  # see [Foundation models][1] in the [Amazon Bedrock User Guide][2].
@@ -3971,7 +4711,6 @@ module Aws::Bedrock
3971
4711
  # resp.model_customization_job_summaries[0].base_model_arn #=> String
3972
4712
  # resp.model_customization_job_summaries[0].job_name #=> String
3973
4713
  # resp.model_customization_job_summaries[0].status #=> String, one of "InProgress", "Completed", "Failed", "Stopping", "Stopped"
3974
- # resp.model_customization_job_summaries[0].last_modified_time #=> Time
3975
4714
  # resp.model_customization_job_summaries[0].status_details.validation_details.status #=> String, one of "InProgress", "Completed", "Stopping", "Stopped", "Failed", "NotStarted"
3976
4715
  # resp.model_customization_job_summaries[0].status_details.validation_details.creation_time #=> Time
3977
4716
  # resp.model_customization_job_summaries[0].status_details.validation_details.last_modified_time #=> Time
@@ -3981,11 +4720,12 @@ module Aws::Bedrock
3981
4720
  # resp.model_customization_job_summaries[0].status_details.training_details.status #=> String, one of "InProgress", "Completed", "Stopping", "Stopped", "Failed", "NotStarted"
3982
4721
  # resp.model_customization_job_summaries[0].status_details.training_details.creation_time #=> Time
3983
4722
  # resp.model_customization_job_summaries[0].status_details.training_details.last_modified_time #=> Time
4723
+ # resp.model_customization_job_summaries[0].last_modified_time #=> Time
3984
4724
  # resp.model_customization_job_summaries[0].creation_time #=> Time
3985
4725
  # resp.model_customization_job_summaries[0].end_time #=> Time
3986
4726
  # resp.model_customization_job_summaries[0].custom_model_arn #=> String
3987
4727
  # resp.model_customization_job_summaries[0].custom_model_name #=> String
3988
- # resp.model_customization_job_summaries[0].customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION"
4728
+ # resp.model_customization_job_summaries[0].customization_type #=> String, one of "FINE_TUNING", "CONTINUED_PRE_TRAINING", "DISTILLATION", "IMPORTED"
3989
4729
  #
3990
4730
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCustomizationJobs AWS API Documentation
3991
4731
  #
@@ -4447,6 +5187,28 @@ module Aws::Bedrock
4447
5187
  req.send_request(options)
4448
5188
  end
4449
5189
 
5190
+ # Put usecase for model access.
5191
+ #
5192
+ # @option params [required, String, StringIO, File] :form_data
5193
+ # Put customer profile Request.
5194
+ #
5195
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5196
+ #
5197
+ # @example Request syntax with placeholder values
5198
+ #
5199
+ # resp = client.put_use_case_for_model_access({
5200
+ # form_data: "data", # required
5201
+ # })
5202
+ #
5203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccess AWS API Documentation
5204
+ #
5205
+ # @overload put_use_case_for_model_access(params = {})
5206
+ # @param [Hash] params ({})
5207
+ def put_use_case_for_model_access(params = {}, options = {})
5208
+ req = build_request(:put_use_case_for_model_access, params)
5209
+ req.send_request(options)
5210
+ end
5211
+
4450
5212
  # Registers an existing Amazon SageMaker endpoint with Amazon Bedrock
4451
5213
  # Marketplace, allowing it to be used with Amazon Bedrock APIs.
4452
5214
  #
@@ -4754,6 +5516,9 @@ module Aws::Bedrock
4754
5516
  # output_enabled: false,
4755
5517
  # },
4756
5518
  # ],
5519
+ # tier_config: {
5520
+ # tier_name: "CLASSIC", # required, accepts CLASSIC, STANDARD
5521
+ # },
4757
5522
  # },
4758
5523
  # content_policy_config: {
4759
5524
  # filters_config: [ # required
@@ -4769,6 +5534,9 @@ module Aws::Bedrock
4769
5534
  # output_enabled: false,
4770
5535
  # },
4771
5536
  # ],
5537
+ # tier_config: {
5538
+ # tier_name: "CLASSIC", # required, accepts CLASSIC, STANDARD
5539
+ # },
4772
5540
  # },
4773
5541
  # word_policy_config: {
4774
5542
  # words_config: [
@@ -4985,7 +5753,7 @@ module Aws::Bedrock
4985
5753
  tracer: tracer
4986
5754
  )
4987
5755
  context[:gem_name] = 'aws-sdk-bedrock'
4988
- context[:gem_version] = '1.46.0'
5756
+ context[:gem_version] = '1.56.0'
4989
5757
  Seahorse::Client::Request.new(handlers, context)
4990
5758
  end
4991
5759