aws-sdk-sagemaker 1.229.0 → 1.230.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb6d11b997345e5af7a1f8651fb81019709ee60407731362d3a8c833e0a5a52e
-  data.tar.gz: a6243d8a7590a29eabb2dbe8c001671fa0c14134354a27dae3b23f30851b4704
+  metadata.gz: 4714c92d28a9628d423fb1e039eb213a8194c3903088d973d175910b662cec28
+  data.tar.gz: 581d67e3a3055f78f9514336b466ff3af3cb4a7c1456f2ced007ecaeacc054bc
 SHA512:
-  metadata.gz: d5b89bd011a2ecd22be8fe069a07c64ee86642ca3cd0f3342f99b1b6901bced3f24da7a8be5fa1e9c0ee0aecfc05bd237cbd5b3804407c29b9c074f18ca55ba0
-  data.tar.gz: 399bd1b86169a0bcb4f18fa600e9076970ccea381b10ad9549ddb9a6adbcc697e430d90f255e2d2a70525a3dc3c7e1b436943da60d5289b81d849ab62ac5420c
+  metadata.gz: 6dd976b4898e389d7a2224c5bc5d864573241b9acc31e02d63887dcddf3fb2a58c9fbc0d9421c8247ddc80902d6ede3dabdb40d36cb1a10d4b071a3099c8543a
+  data.tar.gz: 8bdbac7274569f95b06eb59baa4e3d2da803ef04df39aff80669b575256e42942ff9ba00ddff71adc084d751cad2c50660448ed50e3fc6d2a2acab647769e1c4

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.230.0 (2024-01-26)
+------------------
+
+* Feature - Amazon SageMaker Automatic Model Tuning now provides an API to programmatically delete tuning jobs.
+
 1.229.0 (2024-01-14)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.229.0
+1.230.0

data/lib/aws-sdk-sagemaker/client.rb

@@ -2297,7 +2297,7 @@ module Aws::SageMaker
     end
 
     # Creates a `Domain`. A domain consists of an associated Amazon Elastic
-    # File System (EFS) volume, a list of authorized users, and a variety of
+    # File System volume, a list of authorized users, and a variety of
     # security, application, policy, and Amazon Virtual Private Cloud (VPC)
     # configurations. Users within a domain can share notebook files and
     # other artifacts with each other.
@@ -2317,8 +2317,8 @@ module Aws::SageMaker
     #
     # **VPC configuration**
     #
-    # All traffic between the domain and the EFS volume is through the
-    # specified VPC and subnets. For other traffic, you can specify the
+    # All traffic between the domain and the Amazon EFS volume is through
+    # the specified VPC and subnets. For other traffic, you can specify the
     # `AppNetworkAccessType` parameter. `AppNetworkAccessType` corresponds
     # to the network access type that you choose when you onboard to the
     # domain. The following options are available:
@@ -9689,6 +9689,32 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
+    # Deletes a hyperparameter tuning job. The
+    # `DeleteHyperParameterTuningJob` API deletes only the tuning job entry
+    # that was created in SageMaker when you called the
+    # `CreateHyperParameterTuningJob` API. It does not delete training jobs,
+    # artifacts, or the IAM role that you specified when creating the model.
+    #
+    # @option params [required, String] :hyper_parameter_tuning_job_name
+    #   The name of the hyperparameter tuning job that you want to delete.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_hyper_parameter_tuning_job({
+    #     hyper_parameter_tuning_job_name: "HyperParameterTuningJobName", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteHyperParameterTuningJob AWS API Documentation
+    #
+    # @overload delete_hyper_parameter_tuning_job(params = {})
+    # @param [Hash] params ({})
+    def delete_hyper_parameter_tuning_job(params = {}, options = {})
+      req = build_request(:delete_hyper_parameter_tuning_job, params)
+      req.send_request(options)
+    end
+
     # Deletes a SageMaker image and all versions of the image. The container
     # images aren't deleted.
     #
@@ -14136,7 +14162,7 @@ module Aws::SageMaker
     # Gets a description for the specified model group.
     #
     # @option params [required, String] :model_package_group_name
-    #   The name of gthe model group to describe.
+    #   The name of the model group to describe.
     #
     # @return [Types::DescribeModelPackageGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -23712,15 +23738,18 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
-    # Deploys the new `EndpointConfig` specified in the request, switches to
-    # using newly created endpoint, and then deletes resources provisioned
-    # for the endpoint using the previous `EndpointConfig` (there is no
-    # availability loss).
+    # Deploys the `EndpointConfig` specified in the request to a new fleet
+    # of instances. SageMaker shifts endpoint traffic to the new instances
+    # with the updated endpoint configuration and then deletes the old
+    # instances using the previous `EndpointConfig` (there is no
+    # availability loss). For more information about how to control the
+    # update and traffic shifting process, see [ Update models in
+    # production][1].
     #
     # When SageMaker receives the request, it sets the endpoint status to
     # `Updating`. After updating the endpoint, it sets the status to
     # `InService`. To check the status of an endpoint, use the
-    # [DescribeEndpoint][1] API.
+    # [DescribeEndpoint][2] API.
     #
     # <note markdown="1"> You must not delete an `EndpointConfig` in use by an endpoint that is
     # live or while the `UpdateEndpoint` or `CreateEndpoint` operations are
@@ -23736,7 +23765,8 @@ module Aws::SageMaker
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
+    # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html
+    # [2]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html
     #
     # @option params [required, String] :endpoint_name
     #   The name of the endpoint whose configuration you want to update.
@@ -25896,7 +25926,7 @@ module Aws::SageMaker
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemaker'
-      context[:gem_version] = '1.229.0'
+      context[:gem_version] = '1.230.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-sagemaker/client_api.rb

@@ -517,6 +517,7 @@ module Aws::SageMaker
     DeleteHubRequest = Shapes::StructureShape.new(name: 'DeleteHubRequest')
     DeleteHumanTaskUiRequest = Shapes::StructureShape.new(name: 'DeleteHumanTaskUiRequest')
     DeleteHumanTaskUiResponse = Shapes::StructureShape.new(name: 'DeleteHumanTaskUiResponse')
+    DeleteHyperParameterTuningJobRequest = Shapes::StructureShape.new(name: 'DeleteHyperParameterTuningJobRequest')
     DeleteImageRequest = Shapes::StructureShape.new(name: 'DeleteImageRequest')
     DeleteImageResponse = Shapes::StructureShape.new(name: 'DeleteImageResponse')
     DeleteImageVersionRequest = Shapes::StructureShape.new(name: 'DeleteImageVersionRequest')
@@ -3924,6 +3925,9 @@ module Aws::SageMaker
 
     DeleteHumanTaskUiResponse.struct_class = Types::DeleteHumanTaskUiResponse
 
+    DeleteHyperParameterTuningJobRequest.add_member(:hyper_parameter_tuning_job_name, Shapes::ShapeRef.new(shape: HyperParameterTuningJobName, required: true, location_name: "HyperParameterTuningJobName"))
+    DeleteHyperParameterTuningJobRequest.struct_class = Types::DeleteHyperParameterTuningJobRequest
+
     DeleteImageRequest.add_member(:image_name, Shapes::ShapeRef.new(shape: ImageName, required: true, location_name: "ImageName"))
     DeleteImageRequest.struct_class = Types::DeleteImageRequest
 
@@ -10692,6 +10696,14 @@ module Aws::SageMaker
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFound)
       end)
 
+      api.add_operation(:delete_hyper_parameter_tuning_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteHyperParameterTuningJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DeleteHyperParameterTuningJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+      end)
+
       api.add_operation(:delete_image, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteImage"
         o.http_method = "POST"

data/lib/aws-sdk-sagemaker/endpoints.rb

@@ -1174,6 +1174,20 @@ module Aws::SageMaker
       end
     end
 
+    class DeleteHyperParameterTuningJob
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::SageMaker::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class DeleteImage
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-sagemaker/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::SageMaker
       option(
         :endpoint_provider,
         doc_type: 'Aws::SageMaker::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\
@@ -223,6 +224,8 @@ module Aws::SageMaker
             Aws::SageMaker::Endpoints::DeleteHubContent.build(context)
           when :delete_human_task_ui
             Aws::SageMaker::Endpoints::DeleteHumanTaskUi.build(context)
+          when :delete_hyper_parameter_tuning_job
+            Aws::SageMaker::Endpoints::DeleteHyperParameterTuningJob.build(context)
           when :delete_image
             Aws::SageMaker::Endpoints::DeleteImage.build(context)
           when :delete_image_version

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

@@ -10647,6 +10647,18 @@ module Aws::SageMaker
     #
     class DeleteHumanTaskUiResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] hyper_parameter_tuning_job_name
+    #   The name of the hyperparameter tuning job that you want to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteHyperParameterTuningJobRequest AWS API Documentation
+    #
+    class DeleteHyperParameterTuningJobRequest < Struct.new(
+      :hyper_parameter_tuning_job_name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] image_name
     #   The name of the image to delete.
     #   @return [String]
@@ -12539,8 +12551,7 @@ module Aws::SageMaker
     #   @return [String]
     #
     # @!attribute [rw] home_efs_file_system_id
-    #   The ID of the Amazon Elastic File System (EFS) managed by this
-    #   Domain.
+    #   The ID of the Amazon Elastic File System managed by this Domain.
     #   @return [String]
     #
     # @!attribute [rw] single_sign_on_managed_application_instance_id
@@ -13244,17 +13255,17 @@ module Aws::SageMaker
     #   @return [Types::OfflineStoreConfig]
     #
     # @!attribute [rw] throughput_config
-    #   Active throughput configuration of the feature group. Used to set
-    #   feature group throughput configuration. There are two modes:
-    #   `ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are charged
-    #   for data reads and writes that your application performs on your
-    #   feature group. You do not need to specify read and write throughput
-    #   because Feature Store accommodates your workloads as they ramp up
-    #   and down. You can switch a feature group to on-demand only once in a
-    #   24 hour period. With provisioned throughput mode, you specify the
-    #   read and write capacity per second that you expect your application
-    #   to require, and you are billed based on those limits. Exceeding
-    #   provisioned throughput will result in your requests being throttled.
+    #   Active throughput configuration of the feature group. There are two
+    #   modes: `ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are
+    #   charged for data reads and writes that your application performs on
+    #   your feature group. You do not need to specify read and write
+    #   throughput because Feature Store accommodates your workloads as they
+    #   ramp up and down. You can switch a feature group to on-demand only
+    #   once in a 24 hour period. With provisioned throughput mode, you
+    #   specify the read and write capacity per second that you expect your
+    #   application to require, and you are billed based on those limits.
+    #   Exceeding provisioned throughput will result in your requests being
+    #   throttled.
     #
     #   Note: `PROVISIONED` throughput mode is supported only for feature
     #   groups that are offline-only, or use the [ `Standard` ][1] tier
@@ -13756,8 +13767,7 @@ module Aws::SageMaker
     #   @return [Array<Types::HyperParameterTrainingJobDefinition>]
     #
     # @!attribute [rw] hyper_parameter_tuning_job_status
-    #   The status of the tuning job: InProgress, Completed, Failed,
-    #   Stopping, or Stopped.
+    #   The status of the tuning job.
     #   @return [String]
     #
     # @!attribute [rw] creation_time
@@ -15054,7 +15064,7 @@ module Aws::SageMaker
     end
 
     # @!attribute [rw] model_package_group_name
-    #   The name of gthe model group to describe.
+    #   The name of the model group to describe.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelPackageGroupInput AWS API Documentation
@@ -30211,14 +30221,22 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
-    # The access configuration file for the ML model. You can explicitly
-    # accept the model end-user license agreement (EULA) within the
-    # `ModelAccessConfig`. For more information, see [End-user license
-    # agreements][1].
+    # The access configuration file to control access to the ML model. You
+    # can explicitly accept the model end-user license agreement (EULA)
+    # within the `ModelAccessConfig`.
+    #
+    # * If you are a Jumpstart user, see the [End-user license
+    #   agreements][1] section for more details on accepting the EULA.
+    #
+    # * If you are an AutoML user, see the *Optional Parameters* section of
+    #   *Create an AutoML job to fine-tune text generation models using the
+    #   API* for details on [How to set the EULA acceptance when fine-tuning
+    #   a model using the AutoML API][2].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula
+    # [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params
     #
     # @!attribute [rw] accept_eula
     #   Specifies agreement to the model end-user license agreement (EULA).
@@ -37731,7 +37749,7 @@ module Aws::SageMaker
     #   either a key name prefix or a manifest. For example:
     #
     #   * A key name prefix might look like this:
-    #     `s3://bucketname/exampleprefix`
+    #     `s3://bucketname/exampleprefix/`
     #
     #   * A manifest might look like this:
     #     `s3://bucketname/example.manifest`
@@ -40092,14 +40110,22 @@ module Aws::SageMaker
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] model_access_config
-    #   The access configuration file for the ML model. You can explicitly
-    #   accept the model end-user license agreement (EULA) within the
-    #   `ModelAccessConfig`. For more information, see [End-user license
-    #   agreements][1].
+    #   The access configuration file to control access to the ML model. You
+    #   can explicitly accept the model end-user license agreement (EULA)
+    #   within the `ModelAccessConfig`.
+    #
+    #   * If you are a Jumpstart user, see the [End-user license
+    #     agreements][1] section for more details on accepting the EULA.
+    #
+    #   * If you are an AutoML user, see the *Optional Parameters* section
+    #     of *Create an AutoML job to fine-tune text generation models using
+    #     the API* for details on [How to set the EULA acceptance when
+    #     fine-tuning a model using the AutoML API][2].
     #
     #
     #
     #   [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula
+    #   [2]: https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params
     #   @return [Types::ModelAccessConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TextGenerationJobConfig AWS API Documentation
@@ -40177,17 +40203,17 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
-    # Active throughput configuration of the feature group. Used to set
-    # feature group throughput configuration. There are two modes:
-    # `ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are charged
-    # for data reads and writes that your application performs on your
-    # feature group. You do not need to specify read and write throughput
-    # because Feature Store accommodates your workloads as they ramp up and
-    # down. You can switch a feature group to on-demand only once in a 24
-    # hour period. With provisioned throughput mode, you specify the read
-    # and write capacity per second that you expect your application to
-    # require, and you are billed based on those limits. Exceeding
-    # provisioned throughput will result in your requests being throttled.
+    # Active throughput configuration of the feature group. There are two
+    # modes: `ON_DEMAND` and `PROVISIONED`. With on-demand mode, you are
+    # charged for data reads and writes that your application performs on
+    # your feature group. You do not need to specify read and write
+    # throughput because Feature Store accommodates your workloads as they
+    # ramp up and down. You can switch a feature group to on-demand only
+    # once in a 24 hour period. With provisioned throughput mode, you
+    # specify the read and write capacity per second that you expect your
+    # application to require, and you are billed based on those limits.
+    # Exceeding provisioned throughput will result in your requests being
+    # throttled.
     #
     # Note: `PROVISIONED` throughput mode is supported only for feature
     # groups that are offline-only, or use the [ `Standard` ][1] tier online
@@ -41777,7 +41803,7 @@ module Aws::SageMaker
     #   either a key name prefix or a manifest. For example:
     #
     #   * A key name prefix might look like this:
-    #     `s3://bucketname/exampleprefix`.
+    #     `s3://bucketname/exampleprefix/`.
     #
     #   * A manifest might look like this:
     #     `s3://bucketname/example.manifest`

data/lib/aws-sdk-sagemaker.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-sagemaker/customizations'
 # @!group service
 module Aws::SageMaker
 
-  GEM_VERSION = '1.229.0'
+  GEM_VERSION = '1.230.0'
 
 end