aws-sdk-sagemaker 1.156.0 → 1.158.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea5a222e15f74abae62c3449bfdaf0d50003065a7fd2eaa8124a99adce444f7
-  data.tar.gz: 9e8fff8720cf17fb07496681ea3a073dd1afe0e5aa0c1d7897042a5c37630df2
+  metadata.gz: afa3d9aad52d2754e4e54670bff15a1be4f111158df8df74341671fa4f4a5573
+  data.tar.gz: 609ae29dcd112366ce30892884bafc2ea3c5d7a8dea344374783928d7865582a
 SHA512:
-  metadata.gz: 7ea7af4b20725ca41e4e95c3adce517e443b181aad2e6ca2a9c45eb75de68c66cfd2dda9ba2b9e924ab30245ecea33e776c80c2fceaca1c89fb7b2736317470e
-  data.tar.gz: 8e2a6cce64c07e97470ff35b21dae7c45435af198553e734c5d04147e83fffd126d80d7a8a78f9a2fa444331650e948c98433282f6ec469a98715b6f6c01ff8c
+  metadata.gz: 036e5c82c6a7a42f3e10141e8c00a2687011434939868f4990b847474b04ec3a4ddd35a3307eb3c44a864ef0bd140836b2bf11223078ccc43aecf02f26c81d75
+  data.tar.gz: c557948a687fe872b8c85c3ba5084c2ac42717fc3f811171d1ea3ecd220f7ae5a714807fb6f285372168f7618b9168d6e9c4a2bda7ea19f125c5668ddf62d54e

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.158.0 (2022-12-20)
+------------------
+
+* Feature - Amazon SageMaker Autopilot adds support for new objective metrics in CreateAutoMLJob API.
+
+1.157.0 (2022-12-19)
+------------------
+
+* Feature - AWS Sagemaker - Sagemaker Images now supports Aliases as secondary identifiers for ImageVersions. SageMaker Images now supports additional metadata for ImageVersions for better images management.
+
 1.156.0 (2022-12-16)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.156.0
+1.158.0

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

@@ -1260,7 +1260,7 @@ module Aws::SageMaker
     #     },
     #     problem_type: "BinaryClassification", # accepts BinaryClassification, MulticlassClassification, Regression
     #     auto_ml_job_objective: {
-    #       metric_name: "Accuracy", # required, accepts Accuracy, MSE, F1, F1macro, AUC
+    #       metric_name: "Accuracy", # required, accepts Accuracy, MSE, F1, F1macro, AUC, RMSE, MAE, R2, BalancedAccuracy, Precision, PrecisionMacro, Recall, RecallMacro
     #     },
     #     auto_ml_job_config: {
     #       completion_criteria: {
@@ -2702,11 +2702,16 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
-    # Creates an SageMaker *experiment*. An experiment is a collection of
+    # Creates a SageMaker *experiment*. An experiment is a collection of
     # *trials* that are observed, compared and evaluated as a group. A trial
     # is a set of steps, called *trial components*, that produce a machine
     # learning model.
     #
+    # <note markdown="1"> In the Studio UI, trials are referred to as *run groups* and trial
+    # components are referred to as *runs*.
+    #
+    #  </note>
+    #
     # The goal of an experiment is to determine the components that produce
     # the best model. Multiple trials are performed, each one isolating and
     # measuring the impact of a change to one or more inputs, while keeping
@@ -3587,8 +3592,8 @@ module Aws::SageMaker
     #   The name of the image. Must be unique to your account.
     #
     # @option params [required, String] :role_arn
-    #   The Amazon Resource Name (ARN) of an IAM role that enables Amazon
-    #   SageMaker to perform tasks on your behalf.
+    #   The ARN of an IAM role that enables Amazon SageMaker to perform tasks
+    #   on your behalf.
     #
     # @option params [Array<Types::Tag>] :tags
     #   A list of tags to apply to the image.
@@ -3648,6 +3653,55 @@ module Aws::SageMaker
     # @option params [required, String] :image_name
     #   The `ImageName` of the `Image` to create a version of.
     #
+    # @option params [Array<String>] :aliases
+    #   A list of aliases created with the image version.
+    #
+    # @option params [String] :vendor_guidance
+    #   The stability of the image version, specified by the maintainer.
+    #
+    #   * `NOT_PROVIDED`\: The maintainers did not provide a status for image
+    #     version stability.
+    #
+    #   * `STABLE`\: The image version is stable.
+    #
+    #   * `TO_BE_ARCHIVED`\: The image version is set to be archived. Custom
+    #     image versions that are set to be archived are automatically
+    #     archived after three months.
+    #
+    #   * `ARCHIVED`\: The image version is archived. Archived image versions
+    #     are not searchable and are no longer actively supported.
+    #
+    # @option params [String] :job_type
+    #   Indicates SageMaker job type compatibility.
+    #
+    #   * `TRAINING`\: The image version is compatible with SageMaker training
+    #     jobs.
+    #
+    #   * `INFERENCE`\: The image version is compatible with SageMaker
+    #     inference jobs.
+    #
+    #   * `NOTEBOOK_KERNEL`\: The image version is compatible with SageMaker
+    #     notebook kernels.
+    #
+    # @option params [String] :ml_framework
+    #   The machine learning framework vended in the image version.
+    #
+    # @option params [String] :programming_lang
+    #   The supported programming language and its version.
+    #
+    # @option params [String] :processor
+    #   Indicates CPU or GPU compatibility.
+    #
+    #   * `CPU`\: The image version is compatible with CPU.
+    #
+    #   * `GPU`\: The image version is compatible with GPU.
+    #
+    # @option params [Boolean] :horovod
+    #   Indicates Horovod compatibility.
+    #
+    # @option params [String] :release_notes
+    #   The maintainer description of the image version.
+    #
     # @return [Types::CreateImageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateImageVersionResponse#image_version_arn #image_version_arn} => String
@@ -3658,6 +3712,14 @@ module Aws::SageMaker
     #     base_image: "ImageBaseImage", # required
     #     client_token: "ClientToken", # required
     #     image_name: "ImageName", # required
+    #     aliases: ["SageMakerImageVersionAlias"],
+    #     vendor_guidance: "NOT_PROVIDED", # accepts NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, ARCHIVED
+    #     job_type: "TRAINING", # accepts TRAINING, INFERENCE, NOTEBOOK_KERNEL
+    #     ml_framework: "MLFramework",
+    #     programming_lang: "ProgrammingLang",
+    #     processor: "CPU", # accepts CPU, GPU
+    #     horovod: false,
+    #     release_notes: "ReleaseNotes",
     #   })
     #
     # @example Response structure
@@ -8394,18 +8456,22 @@ module Aws::SageMaker
     # version represents isn't deleted.
     #
     # @option params [required, String] :image_name
-    #   The name of the image.
+    #   The name of the image to delete.
     #
-    # @option params [required, Integer] :version
+    # @option params [Integer] :version
     #   The version to delete.
     #
+    # @option params [String] :alias
+    #   The alias of the image to delete.
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_image_version({
     #     image_name: "ImageName", # required
-    #     version: 1, # required
+    #     version: 1,
+    #     alias: "SageMakerImageVersionAlias",
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteImageVersion AWS API Documentation
@@ -9484,7 +9550,7 @@ module Aws::SageMaker
     #   resp.output_data_config.kms_key_id #=> String
     #   resp.output_data_config.s3_output_path #=> String
     #   resp.role_arn #=> String
-    #   resp.auto_ml_job_objective.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.auto_ml_job_objective.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.problem_type #=> String, one of "BinaryClassification", "MulticlassClassification", "Regression"
     #   resp.auto_ml_job_config.completion_criteria.max_candidates #=> Integer
     #   resp.auto_ml_job_config.completion_criteria.max_runtime_per_training_job_in_seconds #=> Integer
@@ -9506,7 +9572,7 @@ module Aws::SageMaker
     #   resp.partial_failure_reasons[0].partial_failure_message #=> String
     #   resp.best_candidate.candidate_name #=> String
     #   resp.best_candidate.final_auto_ml_job_objective_metric.type #=> String, one of "Maximize", "Minimize"
-    #   resp.best_candidate.final_auto_ml_job_objective_metric.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.best_candidate.final_auto_ml_job_objective_metric.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.best_candidate.final_auto_ml_job_objective_metric.value #=> Float
     #   resp.best_candidate.objective_status #=> String, one of "Succeeded", "Pending", "Failed"
     #   resp.best_candidate.candidate_steps #=> Array
@@ -9526,7 +9592,7 @@ module Aws::SageMaker
     #   resp.best_candidate.candidate_properties.candidate_artifact_locations.explainability #=> String
     #   resp.best_candidate.candidate_properties.candidate_artifact_locations.model_insights #=> String
     #   resp.best_candidate.candidate_properties.candidate_metrics #=> Array
-    #   resp.best_candidate.candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.best_candidate.candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.best_candidate.candidate_properties.candidate_metrics[0].value #=> Float
     #   resp.best_candidate.candidate_properties.candidate_metrics[0].set #=> String, one of "Train", "Validation", "Test"
     #   resp.best_candidate.candidate_properties.candidate_metrics[0].standard_metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro", "LogLoss", "InferenceLatency"
@@ -9535,7 +9601,7 @@ module Aws::SageMaker
     #   resp.generate_candidate_definitions_only #=> Boolean
     #   resp.auto_ml_job_artifacts.candidate_definition_notebook_location #=> String
     #   resp.auto_ml_job_artifacts.data_exploration_notebook_location #=> String
-    #   resp.resolved_attributes.auto_ml_job_objective.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.resolved_attributes.auto_ml_job_objective.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.resolved_attributes.problem_type #=> String, one of "BinaryClassification", "MulticlassClassification", "Regression"
     #   resp.resolved_attributes.completion_criteria.max_candidates #=> Integer
     #   resp.resolved_attributes.completion_criteria.max_runtime_per_training_job_in_seconds #=> Integer
@@ -11189,6 +11255,9 @@ module Aws::SageMaker
     #   The version of the image. If not specified, the latest version is
     #   described.
     #
+    # @option params [String] :alias
+    #   The alias of the image version.
+    #
     # @return [Types::DescribeImageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeImageVersionResponse#base_image #base_image} => String
@@ -11200,12 +11269,20 @@ module Aws::SageMaker
     #   * {Types::DescribeImageVersionResponse#image_version_status #image_version_status} => String
     #   * {Types::DescribeImageVersionResponse#last_modified_time #last_modified_time} => Time
     #   * {Types::DescribeImageVersionResponse#version #version} => Integer
+    #   * {Types::DescribeImageVersionResponse#vendor_guidance #vendor_guidance} => String
+    #   * {Types::DescribeImageVersionResponse#job_type #job_type} => String
+    #   * {Types::DescribeImageVersionResponse#ml_framework #ml_framework} => String
+    #   * {Types::DescribeImageVersionResponse#programming_lang #programming_lang} => String
+    #   * {Types::DescribeImageVersionResponse#processor #processor} => String
+    #   * {Types::DescribeImageVersionResponse#horovod #horovod} => Boolean
+    #   * {Types::DescribeImageVersionResponse#release_notes #release_notes} => String
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_image_version({
     #     image_name: "ImageName", # required
     #     version: 1,
+    #     alias: "SageMakerImageVersionAlias",
     #   })
     #
     # @example Response structure
@@ -11219,6 +11296,13 @@ module Aws::SageMaker
     #   resp.image_version_status #=> String, one of "CREATING", "CREATED", "CREATE_FAILED", "DELETING", "DELETE_FAILED"
     #   resp.last_modified_time #=> Time
     #   resp.version #=> Integer
+    #   resp.vendor_guidance #=> String, one of "NOT_PROVIDED", "STABLE", "TO_BE_ARCHIVED", "ARCHIVED"
+    #   resp.job_type #=> String, one of "TRAINING", "INFERENCE", "NOTEBOOK_KERNEL"
+    #   resp.ml_framework #=> String
+    #   resp.programming_lang #=> String
+    #   resp.processor #=> String, one of "CPU", "GPU"
+    #   resp.horovod #=> Boolean
+    #   resp.release_notes #=> String
     #
     #
     # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -14067,6 +14151,58 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
+    # Lists the aliases of a specified image or image version.
+    #
+    # @option params [required, String] :image_name
+    #   The name of the image.
+    #
+    # @option params [String] :alias
+    #   The alias of the image version.
+    #
+    # @option params [Integer] :version
+    #   The version of the image. If image version is not specified, the
+    #   aliases of all versions of the image are listed.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of aliases to return.
+    #
+    # @option params [String] :next_token
+    #   If the previous call to `ListAliases` didn't return the full set of
+    #   aliases, the call returns a token for retrieving the next set of
+    #   aliases.
+    #
+    # @return [Types::ListAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListAliasesResponse#sage_maker_image_version_aliases #sage_maker_image_version_aliases} => Array&lt;String&gt;
+    #   * {Types::ListAliasesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_aliases({
+    #     image_name: "ImageName", # required
+    #     alias: "SageMakerImageVersionAlias",
+    #     version: 1,
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.sage_maker_image_version_aliases #=> Array
+    #   resp.sage_maker_image_version_aliases[0] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListAliases AWS API Documentation
+    #
+    # @overload list_aliases(params = {})
+    # @param [Hash] params ({})
+    def list_aliases(params = {}, options = {})
+      req = build_request(:list_aliases, params)
+      req.send_request(options)
+    end
+
     # Lists the AppImageConfigs in your account and their properties. The
     # list can be filtered by creation time or modified time, and whether
     # the AppImageConfig name contains a specified string.
@@ -14514,7 +14650,7 @@ module Aws::SageMaker
     #   resp.candidates #=> Array
     #   resp.candidates[0].candidate_name #=> String
     #   resp.candidates[0].final_auto_ml_job_objective_metric.type #=> String, one of "Maximize", "Minimize"
-    #   resp.candidates[0].final_auto_ml_job_objective_metric.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.candidates[0].final_auto_ml_job_objective_metric.metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.candidates[0].final_auto_ml_job_objective_metric.value #=> Float
     #   resp.candidates[0].objective_status #=> String, one of "Succeeded", "Pending", "Failed"
     #   resp.candidates[0].candidate_steps #=> Array
@@ -14534,7 +14670,7 @@ module Aws::SageMaker
     #   resp.candidates[0].candidate_properties.candidate_artifact_locations.explainability #=> String
     #   resp.candidates[0].candidate_properties.candidate_artifact_locations.model_insights #=> String
     #   resp.candidates[0].candidate_properties.candidate_metrics #=> Array
-    #   resp.candidates[0].candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC"
+    #   resp.candidates[0].candidate_properties.candidate_metrics[0].metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro"
     #   resp.candidates[0].candidate_properties.candidate_metrics[0].value #=> Float
     #   resp.candidates[0].candidate_properties.candidate_metrics[0].set #=> String, one of "Train", "Validation", "Test"
     #   resp.candidates[0].candidate_properties.candidate_metrics[0].standard_metric_name #=> String, one of "Accuracy", "MSE", "F1", "F1macro", "AUC", "RMSE", "MAE", "R2", "BalancedAccuracy", "Precision", "PrecisionMacro", "Recall", "RecallMacro", "LogLoss", "InferenceLatency"
@@ -21060,8 +21196,8 @@ module Aws::SageMaker
     #   The name of the image to update.
     #
     # @option params [String] :role_arn
-    #   The new Amazon Resource Name (ARN) for the IAM role that enables
-    #   Amazon SageMaker to perform tasks on your behalf.
+    #   The new ARN for the IAM role that enables Amazon SageMaker to perform
+    #   tasks on your behalf.
     #
     # @return [Types::UpdateImageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -21090,6 +21226,103 @@ module Aws::SageMaker
       req.send_request(options)
     end
 
+    # Updates the properties of a SageMaker image version.
+    #
+    # @option params [required, String] :image_name
+    #   The name of the image.
+    #
+    # @option params [String] :alias
+    #   The alias of the image version.
+    #
+    # @option params [Integer] :version
+    #   The version of the image.
+    #
+    # @option params [Array<String>] :aliases_to_add
+    #   A list of aliases to add.
+    #
+    # @option params [Array<String>] :aliases_to_delete
+    #   A list of aliases to delete.
+    #
+    # @option params [String] :vendor_guidance
+    #   The availability of the image version specified by the maintainer.
+    #
+    #   * `NOT_PROVIDED`\: The maintainers did not provide a status for image
+    #     version stability.
+    #
+    #   * `STABLE`\: The image version is stable.
+    #
+    #   * `TO_BE_ARCHIVED`\: The image version is set to be archived. Custom
+    #     image versions that are set to be archived are automatically
+    #     archived after three months.
+    #
+    #   * `ARCHIVED`\: The image version is archived. Archived image versions
+    #     are not searchable and are no longer actively supported.
+    #
+    # @option params [String] :job_type
+    #   Indicates SageMaker job type compatibility.
+    #
+    #   * `TRAINING`\: The image version is compatible with SageMaker training
+    #     jobs.
+    #
+    #   * `INFERENCE`\: The image version is compatible with SageMaker
+    #     inference jobs.
+    #
+    #   * `NOTEBOOK_KERNEL`\: The image version is compatible with SageMaker
+    #     notebook kernels.
+    #
+    # @option params [String] :ml_framework
+    #   The machine learning framework vended in the image version.
+    #
+    # @option params [String] :programming_lang
+    #   The supported programming language and its version.
+    #
+    # @option params [String] :processor
+    #   Indicates CPU or GPU compatibility.
+    #
+    #   * `CPU`\: The image version is compatible with CPU.
+    #
+    #   * `GPU`\: The image version is compatible with GPU.
+    #
+    # @option params [Boolean] :horovod
+    #   Indicates Horovod compatibility.
+    #
+    # @option params [String] :release_notes
+    #   The maintainer description of the image version.
+    #
+    # @return [Types::UpdateImageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateImageVersionResponse#image_version_arn #image_version_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_image_version({
+    #     image_name: "ImageName", # required
+    #     alias: "SageMakerImageVersionAlias",
+    #     version: 1,
+    #     aliases_to_add: ["SageMakerImageVersionAlias"],
+    #     aliases_to_delete: ["SageMakerImageVersionAlias"],
+    #     vendor_guidance: "NOT_PROVIDED", # accepts NOT_PROVIDED, STABLE, TO_BE_ARCHIVED, ARCHIVED
+    #     job_type: "TRAINING", # accepts TRAINING, INFERENCE, NOTEBOOK_KERNEL
+    #     ml_framework: "MLFramework",
+    #     programming_lang: "ProgrammingLang",
+    #     processor: "CPU", # accepts CPU, GPU
+    #     horovod: false,
+    #     release_notes: "ReleaseNotes",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.image_version_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateImageVersion AWS API Documentation
+    #
+    # @overload update_image_version(params = {})
+    # @param [Hash] params ({})
+    def update_image_version(params = {}, options = {})
+      req = build_request(:update_image_version, params)
+      req.send_request(options)
+    end
+
     # Updates an inference experiment that you created. The status of the
     # inference experiment has to be either `Created`, `Running`. For more
     # information on the status of an inference experiment, see
@@ -22472,7 +22705,7 @@ module Aws::SageMaker
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemaker'
-      context[:gem_version] = '1.156.0'
+      context[:gem_version] = '1.158.0'
       Seahorse::Client::Request.new(handlers, context)
     end