aws-sdk-bedrock 1.51.0 → 1.52.0

data/lib/aws-sdk-bedrock/types.rb

@@ -23,6 +23,25 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Information about the agreement availability
+    #
+    # @!attribute [rw] status
+    #   Status of the agreement.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   Error message.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AgreementAvailability AWS API Documentation
+    #
+    class AgreementAvailability < Struct.new(
+      :status,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration details of an automated evaluation job. The
     # `EvaluationDatasetMetricConfig` object is used to specify the prompt
     # datasets, task type, and metric names.
@@ -456,6 +475,35 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] offer_token
+    #   An offer token encapsulates the information for an offer.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_id
+    #   Model Id of the model for the access request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementRequest AWS API Documentation
+    #
+    class CreateFoundationModelAgreementRequest < Struct.new(
+      :offer_token,
+      :model_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] model_id
+    #   Model Id of the model for the access request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementResponse AWS API Documentation
+    #
+    class CreateFoundationModelAgreementResponse < Struct.new(
+      :model_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   The name to give the guardrail.
     #   @return [String]
@@ -1511,6 +1559,22 @@ module Aws::Bedrock
     #
     class DeleteCustomModelResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] model_id
+    #   Model Id of the model access to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementRequest AWS API Documentation
+    #
+    class DeleteFoundationModelAgreementRequest < Struct.new(
+      :model_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementResponse AWS API Documentation
+    #
+    class DeleteFoundationModelAgreementResponse < Aws::EmptyStructure; end
+
     # @!attribute [rw] guardrail_identifier
     #   The unique identifier of the guardrail. This can be an ID or the
     #   ARN.
@@ -1642,6 +1706,35 @@ module Aws::Bedrock
     #
     class DeregisterMarketplaceModelEndpointResponse < Aws::EmptyStructure; end
 
+    # Dimensional price rate.
+    #
+    # @!attribute [rw] dimension
+    #   Dimension for the price rate.
+    #   @return [String]
+    #
+    # @!attribute [rw] price
+    #   Single-dimensional rate information.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   Description of the price rate.
+    #   @return [String]
+    #
+    # @!attribute [rw] unit
+    #   Unit associated with the price.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DimensionalPriceRate AWS API Documentation
+    #
+    class DimensionalPriceRate < Struct.new(
+      :dimension,
+      :price,
+      :description,
+      :unit)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Settings for distilling a foundation model into a smaller and more
     # efficient model.
     #
@@ -2708,6 +2801,50 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] model_id
+    #   The model Id of the foundation model.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityRequest AWS API Documentation
+    #
+    class GetFoundationModelAvailabilityRequest < Struct.new(
+      :model_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] model_id
+    #   The model Id of the foundation model.
+    #   @return [String]
+    #
+    # @!attribute [rw] agreement_availability
+    #   Agreement availability.
+    #   @return [Types::AgreementAvailability]
+    #
+    # @!attribute [rw] authorization_status
+    #   Authorization status.
+    #   @return [String]
+    #
+    # @!attribute [rw] entitlement_availability
+    #   Entitlement availability.
+    #   @return [String]
+    #
+    # @!attribute [rw] region_availability
+    #   Region availability.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityResponse AWS API Documentation
+    #
+    class GetFoundationModelAvailabilityResponse < Struct.new(
+      :model_id,
+      :agreement_availability,
+      :authorization_status,
+      :entitlement_availability,
+      :region_availability)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] model_identifier
     #   The model identifier.
     #   @return [String]
@@ -3687,6 +3824,24 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @api private
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessRequest AWS API Documentation
+    #
+    class GetUseCaseForModelAccessRequest < Aws::EmptyStructure; end
+
+    # @!attribute [rw] form_data
+    #   Get customer profile Response.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessResponse AWS API Documentation
+    #
+    class GetUseCaseForModelAccessResponse < Struct.new(
+      :form_data)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration details for the guardrail.
     #
     # @!attribute [rw] guardrail_id
@@ -5715,6 +5870,20 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # The legal term of the agreement.
+    #
+    # @!attribute [rw] url
+    #   URL to the legal term document.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
+    #
+    class LegalTerm < Struct.new(
+      :url)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] creation_time_before
     #   Return custom models created before the specified time.
     #   @return [Time]
@@ -5895,6 +6064,40 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # @!attribute [rw] model_id
+    #   Model Id of the foundation model.
+    #   @return [String]
+    #
+    # @!attribute [rw] offer_type
+    #   Type of offer associated with the model.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersRequest AWS API Documentation
+    #
+    class ListFoundationModelAgreementOffersRequest < Struct.new(
+      :model_id,
+      :offer_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] model_id
+    #   Model Id of the foundation model.
+    #   @return [String]
+    #
+    # @!attribute [rw] offers
+    #   List of the offers associated with the specified model.
+    #   @return [Array<Types::Offer>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersResponse AWS API Documentation
+    #
+    class ListFoundationModelAgreementOffersResponse < Struct.new(
+      :model_id,
+      :offers)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] by_provider
     #   Return models belonging to the model provider that you specify.
     #   @return [String]
@@ -7289,6 +7492,30 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # An offer dictates usage terms for the model.
+    #
+    # @!attribute [rw] offer_id
+    #   Offer Id for a model offer.
+    #   @return [String]
+    #
+    # @!attribute [rw] offer_token
+    #   Offer token.
+    #   @return [String]
+    #
+    # @!attribute [rw] term_details
+    #   Details about the terms of the offer.
+    #   @return [Types::TermDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Offer AWS API Documentation
+    #
+    class Offer < Struct.new(
+      :offer_id,
+      :offer_token,
+      :term_details)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration details for the model to process the prompt prior to
     # retrieval and response generation.
     #
@@ -7333,6 +7560,20 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Describes the usage-based pricing term.
+    #
+    # @!attribute [rw] rate_card
+    #   Describes a usage price for each dimension.
+    #   @return [Array<Types::DimensionalPriceRate>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PricingTerm AWS API Documentation
+    #
+    class PricingTerm < Struct.new(
+      :rate_card)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Details about a prompt router.
     #
     # @!attribute [rw] prompt_router_name
@@ -7536,6 +7777,22 @@ module Aws::Bedrock
     #
     class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] form_data
+    #   Put customer profile Request.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessRequest AWS API Documentation
+    #
+    class PutUseCaseForModelAccessRequest < Struct.new(
+      :form_data)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessResponse AWS API Documentation
+    #
+    class PutUseCaseForModelAccessResponse < Aws::EmptyStructure; end
+
     # The configuration details for transforming the prompt.
     #
     # @!attribute [rw] type
@@ -8182,6 +8439,20 @@ module Aws::Bedrock
     #
     class StopModelInvocationJobResponse < Aws::EmptyStructure; end
 
+    # Describes a support term.
+    #
+    # @!attribute [rw] refund_policy_description
+    #   Describes the refund policy.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/SupportTerm AWS API Documentation
+    #
+    class SupportTerm < Struct.new(
+      :refund_policy_description)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Definition of the key/value pair for a tag.
     #
     # @!attribute [rw] key
@@ -8242,6 +8513,35 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Describes the usage terms of an offer.
+    #
+    # @!attribute [rw] usage_based_pricing_term
+    #   Describes the usage-based pricing term.
+    #   @return [Types::PricingTerm]
+    #
+    # @!attribute [rw] legal_term
+    #   Describes the legal terms.
+    #   @return [Types::LegalTerm]
+    #
+    # @!attribute [rw] support_term
+    #   Describes the support terms.
+    #   @return [Types::SupportTerm]
+    #
+    # @!attribute [rw] validity_term
+    #   Describes the validity terms.
+    #   @return [Types::ValidityTerm]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TermDetails AWS API Documentation
+    #
+    class TermDetails < Struct.new(
+      :usage_based_pricing_term,
+      :legal_term,
+      :support_term,
+      :validity_term)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration details for text generation using a language model
     # via the `RetrieveAndGenerate` function.
     #
@@ -8664,6 +8964,20 @@ module Aws::Bedrock
       include Aws::Structure
     end
 
+    # Describes the validity terms.
+    #
+    # @!attribute [rw] agreement_duration
+    #   Describes the agreement duration.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidityTerm AWS API Documentation
+    #
+    class ValidityTerm < Struct.new(
+      :agreement_duration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration of a virtual private cloud (VPC). For more
     # information, see [Protect your data using Amazon Virtual Private Cloud
     # and Amazon Web Services PrivateLink][1].

data/lib/aws-sdk-bedrock.rb

@@ -55,7 +55,7 @@ module Aws::Bedrock
   autoload :EndpointProvider, 'aws-sdk-bedrock/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-bedrock/endpoints'
 
-  GEM_VERSION = '1.51.0'
+  GEM_VERSION = '1.52.0'
 
 end
 

data/sig/client.rbs

@@ -447,6 +447,17 @@ module Aws
                                  ) -> _CreateEvaluationJobResponseSuccess
                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateEvaluationJobResponseSuccess
 
+      interface _CreateFoundationModelAgreementResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CreateFoundationModelAgreementResponse]
+        def model_id: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#create_foundation_model_agreement-instance_method
+      def create_foundation_model_agreement: (
+                                               offer_token: ::String,
+                                               model_id: ::String
+                                             ) -> _CreateFoundationModelAgreementResponseSuccess
+                                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFoundationModelAgreementResponseSuccess
+
       interface _CreateGuardrailResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::CreateGuardrailResponse]
         def guardrail_id: () -> ::String
@@ -855,6 +866,15 @@ module Aws
                                ) -> _DeleteCustomModelResponseSuccess
                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCustomModelResponseSuccess
 
+      interface _DeleteFoundationModelAgreementResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::DeleteFoundationModelAgreementResponse]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#delete_foundation_model_agreement-instance_method
+      def delete_foundation_model_agreement: (
+                                               model_id: ::String
+                                             ) -> _DeleteFoundationModelAgreementResponseSuccess
+                                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteFoundationModelAgreementResponseSuccess
+
       interface _DeleteGuardrailResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteGuardrailResponse]
       end
@@ -986,6 +1006,20 @@ module Aws
                                 ) -> _GetFoundationModelResponseSuccess
                               | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFoundationModelResponseSuccess
 
+      interface _GetFoundationModelAvailabilityResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetFoundationModelAvailabilityResponse]
+        def model_id: () -> ::String
+        def agreement_availability: () -> Types::AgreementAvailability
+        def authorization_status: () -> ("AUTHORIZED" | "NOT_AUTHORIZED")
+        def entitlement_availability: () -> ("AVAILABLE" | "NOT_AVAILABLE")
+        def region_availability: () -> ("AVAILABLE" | "NOT_AVAILABLE")
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#get_foundation_model_availability-instance_method
+      def get_foundation_model_availability: (
+                                               model_id: ::String
+                                             ) -> _GetFoundationModelAvailabilityResponseSuccess
+                                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFoundationModelAvailabilityResponseSuccess
+
       interface _GetGuardrailResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetGuardrailResponse]
         def name: () -> ::String
@@ -1210,6 +1244,15 @@ module Aws
                                             ) -> _GetProvisionedModelThroughputResponseSuccess
                                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProvisionedModelThroughputResponseSuccess
 
+      interface _GetUseCaseForModelAccessResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetUseCaseForModelAccessResponse]
+        def form_data: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#get_use_case_for_model_access-instance_method
+      def get_use_case_for_model_access: (
+                                         ) -> _GetUseCaseForModelAccessResponseSuccess
+                                       | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetUseCaseForModelAccessResponseSuccess
+
       interface _ListCustomModelsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListCustomModelsResponse]
         def next_token: () -> ::String
@@ -1250,6 +1293,18 @@ module Aws
                                 ) -> _ListEvaluationJobsResponseSuccess
                               | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListEvaluationJobsResponseSuccess
 
+      interface _ListFoundationModelAgreementOffersResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListFoundationModelAgreementOffersResponse]
+        def model_id: () -> ::String
+        def offers: () -> ::Array[Types::Offer]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#list_foundation_model_agreement_offers-instance_method
+      def list_foundation_model_agreement_offers: (
+                                                    model_id: ::String,
+                                                    ?offer_type: ("ALL" | "PUBLIC")
+                                                  ) -> _ListFoundationModelAgreementOffersResponseSuccess
+                                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFoundationModelAgreementOffersResponseSuccess
+
       interface _ListFoundationModelsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListFoundationModelsResponse]
         def model_summaries: () -> ::Array[Types::FoundationModelSummary]
@@ -1461,6 +1516,15 @@ module Aws
                                                       ) -> _PutModelInvocationLoggingConfigurationResponseSuccess
                                                     | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutModelInvocationLoggingConfigurationResponseSuccess
 
+      interface _PutUseCaseForModelAccessResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::PutUseCaseForModelAccessResponse]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock/Client.html#put_use_case_for_model_access-instance_method
+      def put_use_case_for_model_access: (
+                                           form_data: ::String
+                                         ) -> _PutUseCaseForModelAccessResponseSuccess
+                                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutUseCaseForModelAccessResponseSuccess
+
       interface _RegisterMarketplaceModelEndpointResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::RegisterMarketplaceModelEndpointResponse]
         def marketplace_model_endpoint: () -> Types::MarketplaceModelEndpoint