@aws-sdk/client-sagemaker 3.232.0 → 3.234.0

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

@@ -1,5 +1,5 @@
 import { LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
-import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AlgorithmStatus, AlgorithmStatusDetails, AlgorithmValidationSpecification, AnnotationConsolidationConfig, AppSpecification, AppType, ArtifactSource, AthenaDatasetDefinition, AwsManagedHumanLoopRequestSource, BatchDataCaptureConfig, BatchStrategy, BatchTransformInput, Bias, CaptureContentTypeHeader, CaptureStatus, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, ContainerDefinition, ContentClassifier, ContinuousParameterRange, DataCatalogConfig, DeviceSelectionConfig, EdgeDeploymentConfig, EndpointInput, FeatureDefinition, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, JupyterServerAppSettings, KernelGatewayAppSettings, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, OutputDataConfig, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariantInstanceType, ResourceConfig, S3StorageConfig, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TrainingSpecification, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
+import { ActionSource, ActionStatus, AdditionalInferenceSpecificationDefinition, AlgorithmSpecification, AnnotationConsolidationConfig, AppSpecification, AppType, ArtifactSource, AthenaDatasetDefinition, AwsManagedHumanLoopRequestSource, BatchDataCaptureConfig, BatchStrategy, BatchTransformInput, Bias, CaptureContentTypeHeader, CaptureStatus, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, CognitoConfig, CognitoMemberDefinition, CollectionConfiguration, ContainerDefinition, ContentClassifier, ContinuousParameterRange, DataCatalogConfig, DeviceSelectionConfig, EdgeDeploymentConfig, EndpointInput, FeatureDefinition, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, JupyterServerAppSettings, KernelGatewayAppSettings, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, MonitoringConstraintsResource, MonitoringNetworkConfig, MonitoringOutputConfig, MonitoringResources, MonitoringStatisticsResource, MonitoringStoppingCondition, OutputDataConfig, ProcessingInstanceType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProcessingS3UploadMode, ProductionVariantInstanceType, ResourceConfig, S3StorageConfig, StoppingCondition, Tag, TrainingInputMode, TrainingInstanceType, TransformInput, TransformJobDefinition, TransformOutput, TransformResources, UserContext, UserSettings, VpcConfig } from "./models_0";
 export declare enum TableFormat {
     GLUE = "Glue",
     ICEBERG = "Iceberg"
@@ -1308,22 +1308,20 @@ export interface HyperParameterTuningJobConfig {
      */
     StrategyConfig?: HyperParameterTuningJobStrategyConfig;
     /**
-     * <p>The <a>HyperParameterTuningJobObjective</a> object that specifies the
-     *             objective
-     *             metric for this tuning job.</p>
+     * <p>The <a>HyperParameterTuningJobObjective</a> specifies the objective metric
+     *             used to evaluate the performance of training jobs launched by this tuning job.</p>
      */
     HyperParameterTuningJobObjective?: HyperParameterTuningJobObjective;
     /**
-     * <p>The <a>ResourceLimits</a> object that specifies the
-     *             maximum
-     *             number of training jobs and parallel training jobs for this tuning
+     * <p>The <a>ResourceLimits</a> object that specifies the maximum number of
+     *             training and parallel training jobs that can be used for this hyperparameter tuning
      *             job.</p>
      */
     ResourceLimits: ResourceLimits | undefined;
     /**
      * <p>The <a>ParameterRanges</a> object that specifies the ranges of
-     *             hyperparameters
-     *             that this tuning job searches.</p>
+     *             hyperparameters that this tuning job searches over to find the optimal configuration for
+     *             the highest model performance against .your chosen objective metric. </p>
      */
     ParameterRanges?: ParameterRanges;
     /**
@@ -1351,6 +1349,12 @@ export interface HyperParameterTuningJobConfig {
      * <p>The tuning job's completion criteria.</p>
      */
     TuningJobCompletionCriteria?: TuningJobCompletionCriteria;
+    /**
+     * <p>A value used to initialize a pseudo-random number generator. Setting a random seed and
+     *             using the same seed later for the same tuning job will allow hyperparameter optimization
+     *             to find more a consistent hyperparameter configuration between the two runs.</p>
+     */
+    RandomSeed?: number;
 }
 /**
  * <p>Specifies
@@ -1458,9 +1462,9 @@ export interface HyperParameterTuningInstanceConfig {
  *          <note>
  *             <p>
  *                <code>HyperParameterTuningResourceConfig</code> supports the capabilities of
- *                     <code>ResourceConfig</code> with the exception of <code>KeepAlivePeriodInSeconds</code>.
- *                 Hyperparameter tuning jobs use warm pools by default, which reuse clusters between
- *                 training jobs.</p>
+ *                     <code>ResourceConfig</code> with the exception of
+ *                     <code>KeepAlivePeriodInSeconds</code>. Hyperparameter tuning jobs use warm pools
+ *                 by default, which reuse clusters between training jobs.</p>
  *          </note>
  */
 export interface HyperParameterTuningResourceConfig {
@@ -1836,7 +1840,7 @@ export interface CreateImageRequest {
      */
     ImageName: string | undefined;
     /**
-     * <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
+     * <p>The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>
      */
     RoleArn: string | undefined;
     /**
@@ -1846,10 +1850,25 @@ export interface CreateImageRequest {
 }
 export interface CreateImageResponse {
     /**
-     * <p>The Amazon Resource Name (ARN) of the image.</p>
+     * <p>The ARN of the image.</p>
      */
     ImageArn?: string;
 }
+export declare enum JobType {
+    INFERENCE = "INFERENCE",
+    NOTEBOOK_KERNEL = "NOTEBOOK_KERNEL",
+    TRAINING = "TRAINING"
+}
+export declare enum Processor {
+    CPU = "CPU",
+    GPU = "GPU"
+}
+export declare enum VendorGuidance {
+    ARCHIVED = "ARCHIVED",
+    NOT_PROVIDED = "NOT_PROVIDED",
+    STABLE = "STABLE",
+    TO_BE_ARCHIVED = "TO_BE_ARCHIVED"
+}
 export interface CreateImageVersionRequest {
     /**
      * <p>The registry path of the container image to use as the starting point for this
@@ -1868,10 +1887,84 @@ export interface CreateImageVersionRequest {
      * <p>The <code>ImageName</code> of the <code>Image</code> to create a version of.</p>
      */
     ImageName: string | undefined;
+    /**
+     * <p>A list of aliases created with the image version.</p>
+     */
+    Aliases?: string[];
+    /**
+     * <p>The stability of the image version, specified by the maintainer.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>STABLE</code>: The image version is stable.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </p>
+     *             </li>
+     *          </ul>
+     */
+    VendorGuidance?: VendorGuidance | string;
+    /**
+     * <p>Indicates SageMaker job type compatibility.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>TRAINING</code>: The image version is compatible with SageMaker training jobs.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>INFERENCE</code>: The image version is compatible with SageMaker inference jobs.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker notebook kernels.</p>
+     *             </li>
+     *          </ul>
+     */
+    JobType?: JobType | string;
+    /**
+     * <p>The machine learning framework vended in the image version.</p>
+     */
+    MLFramework?: string;
+    /**
+     * <p>The supported programming language and its version.</p>
+     */
+    ProgrammingLang?: string;
+    /**
+     * <p>Indicates CPU or GPU compatibility.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>CPU</code>: The image version is compatible with CPU.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>GPU</code>: The image version is compatible with GPU.</p>
+     *             </li>
+     *          </ul>
+     */
+    Processor?: Processor | string;
+    /**
+     * <p>Indicates Horovod compatibility.</p>
+     */
+    Horovod?: boolean;
+    /**
+     * <p>The maintainer description of the image version.</p>
+     */
+    ReleaseNotes?: string;
 }
 export interface CreateImageVersionResponse {
     /**
-     * <p>The Amazon Resource Name (ARN) of the image version.</p>
+     * <p>The ARN of the image version.</p>
      */
     ImageVersionArn?: string;
 }
@@ -7663,7 +7756,7 @@ export interface DeleteAppRequest {
      */
     DomainId: string | undefined;
     /**
-     * <p>The user profile name.</p>
+     * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be set.</p>
      */
     UserProfileName?: string;
     /**
@@ -7675,7 +7768,7 @@ export interface DeleteAppRequest {
      */
     AppName: string | undefined;
     /**
-     * <p>The name of the space.</p>
+     * <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be set.</p>
      */
     SpaceName?: string;
 }
@@ -7878,13 +7971,17 @@ export interface DeleteImageResponse {
 }
 export interface DeleteImageVersionRequest {
     /**
-     * <p>The name of the image.</p>
+     * <p>The name of the image to delete.</p>
      */
     ImageName: string | undefined;
     /**
      * <p>The version to delete.</p>
      */
-    Version: number | undefined;
+    Version?: number;
+    /**
+     * <p>The alias of the image to delete.</p>
+     */
+    Alias?: string;
 }
 export interface DeleteImageVersionResponse {
 }
@@ -8232,82 +8329,6 @@ export interface DescribeActionResponse {
      */
     LineageGroupArn?: string;
 }
-export interface DescribeAlgorithmInput {
-    /**
-     * <p>The name of the algorithm to describe.</p>
-     */
-    AlgorithmName: string | undefined;
-}
-export interface DescribeAlgorithmOutput {
-    /**
-     * <p>The name of the algorithm being described.</p>
-     */
-    AlgorithmName: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the algorithm.</p>
-     */
-    AlgorithmArn: string | undefined;
-    /**
-     * <p>A brief summary about the algorithm.</p>
-     */
-    AlgorithmDescription?: string;
-    /**
-     * <p>A timestamp specifying when the algorithm was created.</p>
-     */
-    CreationTime: Date | undefined;
-    /**
-     * <p>Details about training jobs run by this algorithm.</p>
-     */
-    TrainingSpecification: TrainingSpecification | undefined;
-    /**
-     * <p>Details about inference jobs that the algorithm runs.</p>
-     */
-    InferenceSpecification?: InferenceSpecification;
-    /**
-     * <p>Details about configurations for one or more training jobs that SageMaker runs to test the
-     *             algorithm.</p>
-     */
-    ValidationSpecification?: AlgorithmValidationSpecification;
-    /**
-     * <p>The current status of the algorithm.</p>
-     */
-    AlgorithmStatus: AlgorithmStatus | string | undefined;
-    /**
-     * <p>Details about the current status of the algorithm.</p>
-     */
-    AlgorithmStatusDetails: AlgorithmStatusDetails | undefined;
-    /**
-     * <p>The product identifier of the algorithm.</p>
-     */
-    ProductId?: string;
-    /**
-     * <p>Whether the algorithm is certified to be listed in Amazon Web Services
-     *             Marketplace.</p>
-     */
-    CertifyForMarketplace?: boolean;
-}
-export interface DescribeAppRequest {
-    /**
-     * <p>The domain ID.</p>
-     */
-    DomainId: string | undefined;
-    /**
-     * <p>The user profile name.</p>
-     */
-    UserProfileName?: string;
-    /**
-     * <p>The type of app.</p>
-     */
-    AppType: AppType | string | undefined;
-    /**
-     * <p>The name of the app.</p>
-     */
-    AppName: string | undefined;
-    /**
-     * <p>The name of the space.</p>
-     */
-    SpaceName?: string;
-}
 /**
  * @internal
  */
@@ -9376,15 +9397,3 @@ export declare const DescribeActionRequestFilterSensitiveLog: (obj: DescribeActi
  * @internal
  */
 export declare const DescribeActionResponseFilterSensitiveLog: (obj: DescribeActionResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeAlgorithmInputFilterSensitiveLog: (obj: DescribeAlgorithmInput) => any;
-/**
- * @internal
- */
-export declare const DescribeAlgorithmOutputFilterSensitiveLog: (obj: DescribeAlgorithmOutput) => any;
-/**
- * @internal
- */
-export declare const DescribeAppRequestFilterSensitiveLog: (obj: DescribeAppRequest) => any;