@aws-sdk/client-sagemaker 3.682.0 → 3.684.0

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

@@ -1,6 +1,166 @@
 import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
-import { AdditionalInferenceSpecificationDefinition, AmazonQSettings, AnnotationConsolidationConfig, AppInstanceType, AppLifecycleManagement, AppNetworkAccessType, AppSecurityGroupManagement, AppType, ArtifactSource, AsyncInferenceConfig, AuthMode, AutoMLChannel, AutoMLComputeConfig, AutoMLDataSplitConfig, AutoMLJobChannel, AutoMLJobConfig, AutoMLJobObjective, AutoMLOutputDataConfig, AutoMLProblemTypeConfig, AutoMLSecurityConfig, AutoMountHomeEFS, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, ClusterInstanceGroupSpecification, ClusterNodeRecovery, ClusterOrchestrator, CodeEditorAppImageConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, CustomImage, FeatureStatus, GitConfig, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDataSource, OutputDataConfig, ProblemType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TargetDevice, TargetPlatformAccelerator, TargetPlatformArch, TargetPlatformOs, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
+import { AdditionalInferenceSpecificationDefinition, AlgorithmValidationSpecification, AmazonQSettings, AnnotationConsolidationConfig, AppInstanceType, AppLifecycleManagement, AppNetworkAccessType, AppSecurityGroupManagement, AppType, ArtifactSource, AsyncInferenceConfig, AuthMode, AutoMLChannel, AutoMLComputeConfig, AutoMLDataSplitConfig, AutoMLJobChannel, AutoMLJobConfig, AutoMLJobObjective, AutoMLOutputDataConfig, AutoMLProblemTypeConfig, AutoMLSecurityConfig, AutoMountHomeEFS, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, ClusterInstanceGroupSpecification, ClusterNodeRecovery, ClusterOrchestrator, CodeEditorAppImageConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, CustomImage, FeatureStatus, GitConfig, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, JupyterLabAppImageConfig, KernelGatewayImageConfig, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDataSource, OutputDataConfig, ProblemType, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TargetDevice, TargetPlatformAccelerator, TargetPlatformArch, TargetPlatformOs, TrainingInputMode, TrainingInstanceType, TrainingSpecification, TransformJobDefinition, VpcConfig } from "./models_0";
 import { SageMakerServiceException as __BaseException } from "./SageMakerServiceException";
+/**
+ * @public
+ */
+export interface CreateAlgorithmInput {
+    /**
+     * <p>The name of the algorithm.</p>
+     * @public
+     */
+    AlgorithmName: string | undefined;
+    /**
+     * <p>A description of the algorithm.</p>
+     * @public
+     */
+    AlgorithmDescription?: string;
+    /**
+     * <p>Specifies details about training jobs run by this algorithm, including the
+     *             following:</p>
+     *          <ul>
+     *             <li>
+     *                <p>The Amazon ECR path of the container and the version digest of the
+     *                     algorithm.</p>
+     *             </li>
+     *             <li>
+     *                <p>The hyperparameters that the algorithm supports.</p>
+     *             </li>
+     *             <li>
+     *                <p>The instance types that the algorithm supports for training.</p>
+     *             </li>
+     *             <li>
+     *                <p>Whether the algorithm supports distributed training.</p>
+     *             </li>
+     *             <li>
+     *                <p>The metrics that the algorithm emits to Amazon CloudWatch.</p>
+     *             </li>
+     *             <li>
+     *                <p>Which metrics that the algorithm emits can be used as the objective metric for
+     *                     hyperparameter tuning jobs.</p>
+     *             </li>
+     *             <li>
+     *                <p>The input channels that the algorithm supports for training data. For example,
+     *                     an algorithm might support <code>train</code>, <code>validation</code>, and
+     *                         <code>test</code> channels.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    TrainingSpecification: TrainingSpecification | undefined;
+    /**
+     * <p>Specifies details about inference jobs that the algorithm runs, including the
+     *             following:</p>
+     *          <ul>
+     *             <li>
+     *                <p>The Amazon ECR paths of containers that contain the inference code and model
+     *                     artifacts.</p>
+     *             </li>
+     *             <li>
+     *                <p>The instance types that the algorithm supports for transform jobs and
+     *                     real-time endpoints used for inference.</p>
+     *             </li>
+     *             <li>
+     *                <p>The input and output content formats that the algorithm supports for
+     *                     inference.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    InferenceSpecification?: InferenceSpecification;
+    /**
+     * <p>Specifies configurations for one or more training jobs and that SageMaker runs to test the
+     *             algorithm's training code and, optionally, one or more batch transform jobs that SageMaker
+     *             runs to test the algorithm's inference code.</p>
+     * @public
+     */
+    ValidationSpecification?: AlgorithmValidationSpecification;
+    /**
+     * <p>Whether to certify the algorithm so that it can be listed in Amazon Web Services
+     *             Marketplace.</p>
+     * @public
+     */
+    CertifyForMarketplace?: boolean;
+    /**
+     * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
+     *             resources in different ways, for example, by purpose, owner, or environment. For more
+     *             information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
+     * @public
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreateAlgorithmOutput {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the new algorithm.</p>
+     * @public
+     */
+    AlgorithmArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateAppRequest {
+    /**
+     * <p>The domain ID.</p>
+     * @public
+     */
+    DomainId: string | undefined;
+    /**
+     * <p>The user profile name. If this value is not set, then <code>SpaceName</code> must be
+     *       set.</p>
+     * @public
+     */
+    UserProfileName?: string;
+    /**
+     * <p>The name of the space. If this value is not set, then <code>UserProfileName</code> must be
+     *       set.</p>
+     * @public
+     */
+    SpaceName?: string;
+    /**
+     * <p>The type of app.</p>
+     * @public
+     */
+    AppType: AppType | undefined;
+    /**
+     * <p>The name of the app.</p>
+     * @public
+     */
+    AppName: string | undefined;
+    /**
+     * <p>Each tag consists of a key and an optional value. Tag keys must be unique per
+     *       resource.</p>
+     * @public
+     */
+    Tags?: Tag[];
+    /**
+     * <p>The instance type and the Amazon Resource Name (ARN) of the SageMaker image
+     *       created on the instance.</p>
+     *          <note>
+     *             <p>The value of <code>InstanceType</code> passed as part of the <code>ResourceSpec</code>
+     *         in the <code>CreateApp</code> call overrides the value passed as part of the
+     *           <code>ResourceSpec</code> configured for the user profile or the domain. If
+     *           <code>InstanceType</code> is not specified in any of those three <code>ResourceSpec</code>
+     *         values for a <code>KernelGateway</code> app, the <code>CreateApp</code> call fails with a
+     *         request validation error.</p>
+     *          </note>
+     * @public
+     */
+    ResourceSpec?: ResourceSpec;
+}
+/**
+ * @public
+ */
+export interface CreateAppResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the app.</p>
+     * @public
+     */
+    AppArn?: string;
+}
 /**
  * <p>Resource being accessed is in use.</p>
  * @public
@@ -1889,8 +2049,8 @@ export interface CreateDeviceFleetRequest {
     EnableIotRoleAlias?: boolean;
 }
 /**
- * <p>The settings for assigning a custom Amazon EFS file system to a user profile
- *       or space for an Amazon SageMaker Domain.</p>
+ * <p>The settings for assigning a custom Amazon EFS file system to a user profile or
+ *       space for an Amazon SageMaker Domain.</p>
  * @public
  */
 export interface EFSFileSystemConfig {
@@ -1900,15 +2060,15 @@ export interface EFSFileSystemConfig {
      */
     FileSystemId: string | undefined;
     /**
-     * <p>The path to the file system directory that is accessible in Amazon SageMaker
-     *       Studio. Permitted users can access only this directory and below.</p>
+     * <p>The path to the file system directory that is accessible in Amazon SageMaker Studio.
+     *       Permitted users can access only this directory and below.</p>
      * @public
      */
     FileSystemPath?: string;
 }
 /**
- * <p>The settings for assigning a custom file system to a user profile or space for an
- *       Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</p>
+ * <p>The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker
+ *       Studio.</p>
  * @public
  */
 export type CustomFileSystemConfig = CustomFileSystemConfig.EFSFileSystemConfigMember | CustomFileSystemConfig.$UnknownMember;
@@ -2022,8 +2182,8 @@ export interface JupyterLabAppSettings {
      */
     EmrSettings?: EmrSettings;
     /**
-     * <p>The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default
-     *       lifecycle configuration.</p>
+     * <p>The lifecycle configuration that runs before the default lifecycle configuration. It can
+     *       override changes made in the default lifecycle configuration.</p>
      * @public
      */
     BuiltInLifecycleConfigArn?: string;
@@ -2118,7 +2278,8 @@ export interface DefaultSpaceStorageSettings {
 }
 /**
  * <p>The default settings for shared spaces that users create in the domain.</p>
- *          <p>SageMaker applies these settings only to shared spaces. It doesn't apply them to private spaces.</p>
+ *          <p>SageMaker applies these settings only to shared spaces. It doesn't apply them to private
+ *       spaces.</p>
  * @public
  */
 export interface DefaultSpaceSettings {
@@ -2323,16 +2484,12 @@ export type SageMakerImageName = (typeof SageMakerImageName)[keyof typeof SageMa
  */
 export interface HiddenSageMakerImage {
     /**
-     * <p>
-     *       The SageMaker image name that you are hiding from the Studio user interface.
-     *     </p>
+     * <p> The SageMaker image name that you are hiding from the Studio user interface. </p>
      * @public
      */
     SageMakerImageName?: SageMakerImageName;
     /**
-     * <p>
-     *       The version aliases you are hiding from the Studio user interface.
-     *     </p>
+     * <p> The version aliases you are hiding from the Studio user interface. </p>
      * @public
      */
     VersionAliases?: string[];
@@ -2355,16 +2512,12 @@ export interface StudioWebPortalSettings {
      */
     HiddenAppTypes?: AppType[];
     /**
-     * <p>
-     *       The instance types you are hiding from the Studio user interface.
-     *     </p>
+     * <p> The instance types you are hiding from the Studio user interface. </p>
      * @public
      */
     HiddenInstanceTypes?: AppInstanceType[];
     /**
-     * <p>
-     *       The version aliases you are hiding from the Studio user interface.
-     *     </p>
+     * <p> The version aliases you are hiding from the Studio user interface. </p>
      * @public
      */
     HiddenSageMakerImageVersionAliases?: HiddenSageMakerImage[];
@@ -2445,7 +2598,8 @@ export interface UserSettings {
     RSessionAppSettings?: RSessionAppSettings;
     /**
      * <p>The Canvas app settings.</p>
-     *          <p>SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.</p>
+     *          <p>SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas
+     *       app.</p>
      * @public
      */
     CanvasAppSettings?: CanvasAppSettings;
@@ -2714,7 +2868,8 @@ export interface CreateDomainRequest {
      */
     AppSecurityGroupManagement?: AppSecurityGroupManagement;
     /**
-     * <p>Indicates whether custom tag propagation is supported for the domain. Defaults to <code>DISABLED</code>.</p>
+     * <p>Indicates whether custom tag propagation is supported for the domain. Defaults to
+     *         <code>DISABLED</code>.</p>
      * @public
      */
     TagPropagation?: TagPropagation;
@@ -10303,6 +10458,35 @@ export interface ModelPackageModelCard {
      */
     ModelCardStatus?: ModelCardStatus;
 }
+/**
+ * <p>
+ *             A structure describing the current state of the model in its life cycle.
+ *         </p>
+ * @public
+ */
+export interface ModelLifeCycle {
+    /**
+     * <p>
+     *             The current stage in the model life cycle.
+     *         </p>
+     * @public
+     */
+    Stage: string | undefined;
+    /**
+     * <p>
+     *             The current status of a stage in model life cycle.
+     *         </p>
+     * @public
+     */
+    StageStatus: string | undefined;
+    /**
+     * <p>
+     *             Describes the stage related details.
+     *         </p>
+     * @public
+     */
+    StageDescription?: string;
+}
 /**
  * <p>Contains explainability metrics for a model.</p>
  * @public
@@ -10645,6 +10829,13 @@ export interface CreateModelPackageInput {
      * @public
      */
     ModelCard?: ModelPackageModelCard;
+    /**
+     * <p>
+     *             A structure describing the current state of the model in its life cycle.
+     *         </p>
+     * @public
+     */
+    ModelLifeCycle?: ModelLifeCycle;
 }
 /**
  * @public
@@ -11717,116 +11908,6 @@ export interface CreateOptimizationJobRequest {
      */
     VpcConfig?: OptimizationVpcConfig;
 }
-/**
- * @public
- */
-export interface CreateOptimizationJobResponse {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the optimization job.</p>
-     * @public
-     */
-    OptimizationJobArn: string | undefined;
-}
-/**
- * <p>Configuration that controls the parallelism of the pipeline.
- *             By default, the parallelism configuration specified applies to all
- *             executions of the pipeline unless overridden.</p>
- * @public
- */
-export interface ParallelismConfiguration {
-    /**
-     * <p>The max number of steps that can be executed in parallel. </p>
-     * @public
-     */
-    MaxParallelExecutionSteps: number | undefined;
-}
-/**
- * <p>The location of the pipeline definition stored in Amazon S3.</p>
- * @public
- */
-export interface PipelineDefinitionS3Location {
-    /**
-     * <p>Name of the S3 bucket.</p>
-     * @public
-     */
-    Bucket: string | undefined;
-    /**
-     * <p>The object key (or key name) uniquely identifies the
-     *             object in an S3 bucket. </p>
-     * @public
-     */
-    ObjectKey: string | undefined;
-    /**
-     * <p>Version Id of the pipeline definition file. If not specified, Amazon SageMaker
-     *             will retrieve the latest version.</p>
-     * @public
-     */
-    VersionId?: string;
-}
-/**
- * @public
- */
-export interface CreatePipelineRequest {
-    /**
-     * <p>The name of the pipeline.</p>
-     * @public
-     */
-    PipelineName: string | undefined;
-    /**
-     * <p>The display name of the pipeline.</p>
-     * @public
-     */
-    PipelineDisplayName?: string;
-    /**
-     * <p>The <a href="https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/">JSON
-     *          pipeline definition</a> of the pipeline.</p>
-     * @public
-     */
-    PipelineDefinition?: string;
-    /**
-     * <p>The location of the pipeline definition stored in Amazon S3. If specified,
-     *             SageMaker will retrieve the pipeline definition from this location.</p>
-     * @public
-     */
-    PipelineDefinitionS3Location?: PipelineDefinitionS3Location;
-    /**
-     * <p>A description of the pipeline.</p>
-     * @public
-     */
-    PipelineDescription?: string;
-    /**
-     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
-     *          operation. An idempotent operation completes no more than one time.</p>
-     * @public
-     */
-    ClientRequestToken?: string;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.</p>
-     * @public
-     */
-    RoleArn: string | undefined;
-    /**
-     * <p>A list of tags to apply to the created pipeline.</p>
-     * @public
-     */
-    Tags?: Tag[];
-    /**
-     * <p>This is the configuration that controls the parallelism of the pipeline.
-     *             If specified, it applies to all runs of this pipeline by default.</p>
-     * @public
-     */
-    ParallelismConfiguration?: ParallelismConfiguration;
-}
-/**
- * @public
- */
-export interface CreatePipelineResponse {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the created pipeline.</p>
-     * @public
-     */
-    PipelineArn?: string;
-}
 /**
  * @internal
  */