@aws-sdk/client-sagemaker 3.753.0 → 3.758.0

package/dist-types/commands/UpdateHubContentCommand.d.ts

@@ -0,0 +1,123 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateHubContentRequest, UpdateHubContentResponse } from "../models/models_5";
+import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateHubContentCommand}.
+ */
+export interface UpdateHubContentCommandInput extends UpdateHubContentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateHubContentCommand}.
+ */
+export interface UpdateHubContentCommandOutput extends UpdateHubContentResponse, __MetadataBearer {
+}
+declare const UpdateHubContentCommand_base: {
+    new (input: UpdateHubContentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHubContentCommandInput, UpdateHubContentCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateHubContentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHubContentCommandInput, UpdateHubContentCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates SageMaker hub content (either a <code>Model</code> or <code>Notebook</code>
+ *          resource).</p>
+ *          <p>You can update the metadata that describes the resource. In addition to the required request
+ *          fields, specify at least one of the following fields to update:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>HubContentDescription</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>HubContentDisplayName</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>HubContentMarkdown</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>HubContentSearchKeywords</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>SupportStatus</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>For more information about hubs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-curated-hubs.html">Private curated hubs for foundation model access control in JumpStart</a>.</p>
+ *          <note>
+ *             <p>If you want to update a <code>ModelReference</code> resource in your hub, use the
+ *          <code>UpdateHubContentResource</code> API instead.</p>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SageMakerClient, UpdateHubContentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
+ * // const { SageMakerClient, UpdateHubContentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
+ * const client = new SageMakerClient(config);
+ * const input = { // UpdateHubContentRequest
+ *   HubName: "STRING_VALUE", // required
+ *   HubContentName: "STRING_VALUE", // required
+ *   HubContentType: "Model" || "Notebook" || "ModelReference", // required
+ *   HubContentVersion: "STRING_VALUE", // required
+ *   HubContentDisplayName: "STRING_VALUE",
+ *   HubContentDescription: "STRING_VALUE",
+ *   HubContentMarkdown: "STRING_VALUE",
+ *   HubContentSearchKeywords: [ // HubContentSearchKeywordList
+ *     "STRING_VALUE",
+ *   ],
+ *   SupportStatus: "Supported" || "Deprecated" || "Restricted",
+ * };
+ * const command = new UpdateHubContentCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateHubContentResponse
+ * //   HubArn: "STRING_VALUE", // required
+ * //   HubContentArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateHubContentCommandInput - {@link UpdateHubContentCommandInput}
+ * @returns {@link UpdateHubContentCommandOutput}
+ * @see {@link UpdateHubContentCommandInput} for command's `input` shape.
+ * @see {@link UpdateHubContentCommandOutput} for command's `response` shape.
+ * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
+ *
+ * @throws {@link ResourceInUse} (client fault)
+ *  <p>Resource being accessed is in use.</p>
+ *
+ * @throws {@link ResourceNotFound} (client fault)
+ *  <p>Resource being access is not found.</p>
+ *
+ * @throws {@link SageMakerServiceException}
+ * <p>Base exception class for all service exceptions from SageMaker service.</p>
+ *
+ * @public
+ */
+export declare class UpdateHubContentCommand extends UpdateHubContentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateHubContentRequest;
+            output: UpdateHubContentResponse;
+        };
+        sdk: {
+            input: UpdateHubContentCommandInput;
+            output: UpdateHubContentCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateHubContentReferenceCommand.d.ts

@@ -0,0 +1,94 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateHubContentReferenceRequest, UpdateHubContentReferenceResponse } from "../models/models_5";
+import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateHubContentReferenceCommand}.
+ */
+export interface UpdateHubContentReferenceCommandInput extends UpdateHubContentReferenceRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateHubContentReferenceCommand}.
+ */
+export interface UpdateHubContentReferenceCommandOutput extends UpdateHubContentReferenceResponse, __MetadataBearer {
+}
+declare const UpdateHubContentReferenceCommand_base: {
+    new (input: UpdateHubContentReferenceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHubContentReferenceCommandInput, UpdateHubContentReferenceCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateHubContentReferenceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateHubContentReferenceCommandInput, UpdateHubContentReferenceCommandOutput, SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the contents of a SageMaker hub for a <code>ModelReference</code> resource.
+ *          A <code>ModelReference</code> allows you to access public SageMaker JumpStart
+ *          models from within your private hub.</p>
+ *          <p>When using this API, you can update the
+ *          <code>MinVersion</code> field for additional flexibility in the model version. You shouldn't update
+ *          any additional fields when using this API, because the metadata in your private hub
+ *          should match the public JumpStart model's metadata.</p>
+ *          <note>
+ *             <p>If you want to update a <code>Model</code> or <code>Notebook</code>
+ *          resource in your hub, use the <code>UpdateHubContent</code> API instead.</p>
+ *          </note>
+ *          <p>For more information about adding model references to your hub, see
+ *          <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-curated-hubs-admin-guide-add-models.html">
+ *             Add models to a private hub</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SageMakerClient, UpdateHubContentReferenceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
+ * // const { SageMakerClient, UpdateHubContentReferenceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
+ * const client = new SageMakerClient(config);
+ * const input = { // UpdateHubContentReferenceRequest
+ *   HubName: "STRING_VALUE", // required
+ *   HubContentName: "STRING_VALUE", // required
+ *   HubContentType: "Model" || "Notebook" || "ModelReference", // required
+ *   MinVersion: "STRING_VALUE",
+ * };
+ * const command = new UpdateHubContentReferenceCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateHubContentReferenceResponse
+ * //   HubArn: "STRING_VALUE", // required
+ * //   HubContentArn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateHubContentReferenceCommandInput - {@link UpdateHubContentReferenceCommandInput}
+ * @returns {@link UpdateHubContentReferenceCommandOutput}
+ * @see {@link UpdateHubContentReferenceCommandInput} for command's `input` shape.
+ * @see {@link UpdateHubContentReferenceCommandOutput} for command's `response` shape.
+ * @see {@link SageMakerClientResolvedConfig | config} for SageMakerClient's `config` shape.
+ *
+ * @throws {@link ResourceInUse} (client fault)
+ *  <p>Resource being accessed is in use.</p>
+ *
+ * @throws {@link ResourceNotFound} (client fault)
+ *  <p>Resource being access is not found.</p>
+ *
+ * @throws {@link SageMakerServiceException}
+ * <p>Base exception class for all service exceptions from SageMaker service.</p>
+ *
+ * @public
+ */
+export declare class UpdateHubContentReferenceCommand extends UpdateHubContentReferenceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateHubContentReferenceRequest;
+            output: UpdateHubContentReferenceResponse;
+        };
+        sdk: {
+            input: UpdateHubContentReferenceCommandInput;
+            output: UpdateHubContentReferenceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateInferenceComponentCommand.d.ts

@@ -60,6 +60,27 @@ declare const UpdateInferenceComponentCommand_base: {
  *   RuntimeConfig: { // InferenceComponentRuntimeConfig
  *     CopyCount: Number("int"), // required
  *   },
+ *   DeploymentConfig: { // InferenceComponentDeploymentConfig
+ *     RollingUpdatePolicy: { // InferenceComponentRollingUpdatePolicy
+ *       MaximumBatchSize: { // InferenceComponentCapacitySize
+ *         Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
+ *         Value: Number("int"), // required
+ *       },
+ *       WaitIntervalInSeconds: Number("int"), // required
+ *       MaximumExecutionTimeoutInSeconds: Number("int"),
+ *       RollbackMaximumBatchSize: {
+ *         Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required
+ *         Value: Number("int"), // required
+ *       },
+ *     },
+ *     AutoRollbackConfiguration: { // AutoRollbackConfig
+ *       Alarms: [ // AlarmList
+ *         { // Alarm
+ *           AlarmName: "STRING_VALUE",
+ *         },
+ *       ],
+ *     },
+ *   },
  * };
  * const command = new UpdateInferenceComponentCommand(input);
  * const response = await client.send(command);

package/dist-types/commands/index.d.ts

@@ -331,6 +331,8 @@ export * from "./UpdateExperimentCommand";
 export * from "./UpdateFeatureGroupCommand";
 export * from "./UpdateFeatureMetadataCommand";
 export * from "./UpdateHubCommand";
+export * from "./UpdateHubContentCommand";
+export * from "./UpdateHubContentReferenceCommand";
 export * from "./UpdateImageCommand";
 export * from "./UpdateImageVersionCommand";
 export * from "./UpdateInferenceComponentCommand";

package/dist-types/models/models_0.d.ts

@@ -465,7 +465,7 @@ export interface ModelPackageContainerDefinition {
      * <p>The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.</p>
      *          <p>If you are using your own custom algorithm instead of an algorithm provided by SageMaker,
      *             the inference code must meet SageMaker requirements. SageMaker supports both
-     *             <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code>
+     *                 <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code>
      *             image path formats. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon
      *                 SageMaker</a>.</p>
      * @public
@@ -480,7 +480,7 @@ export interface ModelPackageContainerDefinition {
     /**
      * <p>The Amazon S3 path where the model artifacts, which result from model training, are stored.
      *             This path must point to a single <code>gzip</code> compressed tar archive
-     *             (<code>.tar.gz</code> suffix).</p>
+     *                 (<code>.tar.gz</code> suffix).</p>
      *          <note>
      *             <p>The model artifacts must be in an S3 bucket that is in the same region as the
      *                 model package.</p>
@@ -500,7 +500,7 @@ export interface ModelPackageContainerDefinition {
     ProductId?: string | undefined;
     /**
      * <p>The environment variables to set in the Docker container. Each key and value in the
-     *             <code>Environment</code> string to string map can have length of up to 1024. We
+     *                 <code>Environment</code> string to string map can have length of up to 1024. We
      *             support up to 16 entries in the map.</p>
      * @public
      */
@@ -1427,6 +1427,19 @@ export interface FileSystemDataSource {
      */
     DirectoryPath: string | undefined;
 }
+/**
+ * <p>The configuration for a private hub model reference that points to a public SageMaker JumpStart model.</p>
+ *          <p>For more information about private hubs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-curated-hubs.html">Private curated hubs for foundation model access control in JumpStart</a>.</p>
+ * @public
+ */
+export interface HubAccessConfig {
+    /**
+     * <p>The ARN of your private model hub content. This should be a <code>ModelReference</code>
+     *          resource type that points to a SageMaker JumpStart public hub model.</p>
+     * @public
+     */
+    HubContentArn: string | undefined;
+}
 /**
  * @public
  * @enum
@@ -1565,6 +1578,28 @@ export interface S3DataSource {
      * @public
      */
     InstanceGroupNames?: string[] | undefined;
+    /**
+     * <p>The access configuration file to control access to the ML model. You can explicitly accept the model
+     *          end-user license agreement (EULA) within the <code>ModelAccessConfig</code>.</p>
+     *          <ul>
+     *             <li>
+     *                <p>If you are a Jumpstart user, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula">End-user license agreements</a> section for more details on accepting the EULA.</p>
+     *             </li>
+     *             <li>
+     *                <p>If you are an AutoML user, see the  <i>Optional Parameters</i> section of
+     *                <i>Create an AutoML job to fine-tune text generation models using the
+     *                   API</i> for details on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params">How to set the EULA acceptance when fine-tuning a model using the AutoML
+     *                   API</a>.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    ModelAccessConfig?: ModelAccessConfig | undefined;
+    /**
+     * <p>The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.</p>
+     * @public
+     */
+    HubAccessConfig?: HubAccessConfig | undefined;
 }
 /**
  * <p>Describes the location of the channel data.</p>
@@ -7222,8 +7257,15 @@ export interface BatchDeleteClusterNodesRequest {
     /**
      * <p>A list of node IDs to be deleted from the specified cluster.</p>
      *          <note>
-     *             <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances
-     *             that are configured as Slurm controller nodes.</p>
+     *             <ul>
+     *                <li>
+     *                   <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove
+     *                   instances that are configured as Slurm controller nodes.</p>
+     *                </li>
+     *                <li>
+     *                   <p>If you need to delete more than 99 instances, contact <a href="http://aws.amazon.com/contact-us/">Support</a> for assistance.</p>
+     *                </li>
+     *             </ul>
      *          </note>
      * @public
      */
@@ -7427,8 +7469,8 @@ export interface BatchDescribeModelPackageOutput {
      */
     ModelPackageSummaries?: Record<string, BatchDescribeModelPackageSummary> | undefined;
     /**
-     * <p>A map of the resource and BatchDescribeModelPackageError objects
-     *             reporting the error associated with describing the model package.</p>
+     * <p>A map of the resource and BatchDescribeModelPackageError objects reporting the error
+     *             associated with describing the model package.</p>
      * @public
      */
     BatchDescribeModelPackageErrorMap?: Record<string, BatchDescribeModelPackageError> | undefined;
@@ -7697,8 +7739,8 @@ export declare const TrafficRoutingConfigType: {
  */
 export type TrafficRoutingConfigType = (typeof TrafficRoutingConfigType)[keyof typeof TrafficRoutingConfigType];
 /**
- * <p>Defines the traffic routing strategy during an endpoint deployment to shift traffic from the
- *             old fleet to the new fleet.</p>
+ * <p>Defines the traffic routing strategy during an endpoint deployment to shift traffic
+ *             from the old fleet to the new fleet.</p>
  * @public
  */
 export interface TrafficRoutingConfig {
@@ -7707,42 +7749,40 @@ export interface TrafficRoutingConfig {
      *          <ul>
      *             <li>
      *                <p>
-     *                   <code>ALL_AT_ONCE</code>: Endpoint traffic shifts to the new fleet
-     *                 in a single step.
-     *             </p>
+     *                   <code>ALL_AT_ONCE</code>: Endpoint traffic shifts to the new fleet in a single
+     *                     step. </p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>CANARY</code>: Endpoint traffic shifts to the new fleet
-     *                 in two steps. The first step is the canary, which is a small portion of the traffic. The
-     *                 second step is the remainder of the traffic.
-     *             </p>
+     *                   <code>CANARY</code>: Endpoint traffic shifts to the new fleet in two steps.
+     *                     The first step is the canary, which is a small portion of the traffic. The
+     *                     second step is the remainder of the traffic. </p>
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>LINEAR</code>: Endpoint traffic shifts to the new fleet in
-     *                 n steps of a configurable size.
-     *             </p>
+     *                   <code>LINEAR</code>: Endpoint traffic shifts to the new fleet in n steps of a
+     *                     configurable size. </p>
      *             </li>
      *          </ul>
      * @public
      */
     Type: TrafficRoutingConfigType | undefined;
     /**
-     * <p>The waiting time (in seconds) between incremental steps to turn on traffic on the
-     *             new endpoint fleet.</p>
+     * <p>The waiting time (in seconds) between incremental steps to turn on traffic on the new
+     *             endpoint fleet.</p>
      * @public
      */
     WaitIntervalInSeconds: number | undefined;
     /**
-     * <p>Batch size for the first step to turn on traffic on the new endpoint fleet. <code>Value</code> must be less than
-     *             or equal to 50% of the variant's total instance count.</p>
+     * <p>Batch size for the first step to turn on traffic on the new endpoint fleet.
+     *                 <code>Value</code> must be less than or equal to 50% of the variant's total instance
+     *             count.</p>
      * @public
      */
     CanarySize?: CapacitySize | undefined;
     /**
-     * <p>Batch size for each step to turn on traffic on the new endpoint fleet. <code>Value</code> must be
-     *             10-50% of the variant's total instance count.</p>
+     * <p>Batch size for each step to turn on traffic on the new endpoint fleet.
+     *                 <code>Value</code> must be 10-50% of the variant's total instance count.</p>
      * @public
      */
     LinearStepSize?: CapacitySize | undefined;
@@ -8219,9 +8259,9 @@ export interface CheckpointConfig {
     LocalPath?: string | undefined;
 }
 /**
- * <p>The container for the metadata for the ClarifyCheck step. For more information,
- *             see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check">ClarifyCheck step</a> in the <i>Amazon SageMaker Developer Guide</i>.
- *         </p>
+ * <p>The container for the metadata for the ClarifyCheck step. For more information, see
+ *             the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/build-and-manage-steps.html#step-type-clarify-check">ClarifyCheck step</a> in the <i>Amazon SageMaker Developer
+ *                 Guide</i>. </p>
  * @public
  */
 export interface ClarifyCheckStepMetadata {
@@ -8251,21 +8291,25 @@ export interface ClarifyCheckStepMetadata {
      */
     ViolationReport?: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.</p>
+     * <p>The Amazon Resource Name (ARN) of the check processing job that was run by this step's
+     *             execution.</p>
      * @public
      */
     CheckJobArn?: string | undefined;
     /**
-     * <p>This flag indicates if the drift check against the previous baseline will be skipped or not.
-     *             If it is set to <code>False</code>, the previous baseline of the configured check type must be available.</p>
+     * <p>This flag indicates if the drift check against the previous baseline will be skipped
+     *             or not. If it is set to <code>False</code>, the previous baseline of the configured
+     *             check type must be available.</p>
      * @public
      */
     SkipCheck?: boolean | undefined;
     /**
-     * <p>This flag indicates if a newly calculated baseline can be accessed through step properties
-     *             <code>BaselineUsedForDriftCheckConstraints</code> and <code>BaselineUsedForDriftCheckStatistics</code>.
-     *             If it is set to <code>False</code>, the previous baseline of the configured check type must also be available.
-     *             These can be accessed through the <code>BaselineUsedForDriftCheckConstraints</code> property. </p>
+     * <p>This flag indicates if a newly calculated baseline can be accessed through step
+     *             properties <code>BaselineUsedForDriftCheckConstraints</code> and
+     *                 <code>BaselineUsedForDriftCheckStatistics</code>. If it is set to
+     *             <code>False</code>, the previous baseline of the configured check type must also be
+     *             available. These can be accessed through the
+     *                 <code>BaselineUsedForDriftCheckConstraints</code> property. </p>
      * @public
      */
     RegisterNewBaseline?: boolean | undefined;
@@ -10434,19 +10478,3 @@ export interface ContinuousParameterRange {
      */
     ScalingType?: HyperParameterScalingType | undefined;
 }
-/**
- * <p>Defines the possible values for a continuous hyperparameter.</p>
- * @public
- */
-export interface ContinuousParameterRangeSpecification {
-    /**
-     * <p>The minimum floating-point value allowed.</p>
-     * @public
-     */
-    MinValue: string | undefined;
-    /**
-     * <p>The maximum floating-point value allowed.</p>
-     * @public
-     */
-    MaxValue: string | undefined;
-}