@aws-sdk/client-sagemaker 3.645.0 → 3.648.0

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

@@ -1,5 +1,205 @@
-import { LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
-import { AdditionalInferenceSpecificationDefinition, AmazonQSettings, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppType, AsyncInferenceConfig, AuthMode, AutoMLComputeConfig, AutoMLDataSplitConfig, AutoMLJobChannel, AutoMLJobObjective, AutoMLOutputDataConfig, AutoMLProblemTypeConfig, AutoMLSecurityConfig, AutoMountHomeEFS, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, ClusterInstanceGroupSpecification, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, CustomImage, FeatureStatus, GitConfig, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDataSource, ModelDeployConfig, OutputDataConfig, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TargetDevice, TargetPlatformAccelerator, TargetPlatformArch, TargetPlatformOs, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
+import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
+import { AdditionalInferenceSpecificationDefinition, AmazonQSettings, AnnotationConsolidationConfig, 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 { SageMakerServiceException as __BaseException } from "./SageMakerServiceException";
+/**
+ * <p>Resource being accessed is in use.</p>
+ * @public
+ */
+export declare class ResourceInUse extends __BaseException {
+    readonly name: "ResourceInUse";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceInUse, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface CreateAppImageConfigRequest {
+    /**
+     * <p>The name of the AppImageConfig. Must be unique to your account.</p>
+     * @public
+     */
+    AppImageConfigName: string | undefined;
+    /**
+     * <p>A list of tags to apply to the AppImageConfig.</p>
+     * @public
+     */
+    Tags?: Tag[];
+    /**
+     * <p>The KernelGatewayImageConfig. You can only specify one image kernel in the
+     *          AppImageConfig API. This kernel will be shown to users before the
+     *          image starts. Once the image runs, all kernels are visible in JupyterLab.</p>
+     * @public
+     */
+    KernelGatewayImageConfig?: KernelGatewayImageConfig;
+    /**
+     * <p>The <code>JupyterLabAppImageConfig</code>. You can only specify one image kernel in the <code>AppImageConfig</code> API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab.</p>
+     * @public
+     */
+    JupyterLabAppImageConfig?: JupyterLabAppImageConfig;
+    /**
+     * <p>The <code>CodeEditorAppImageConfig</code>. You can only specify one image kernel
+     *       in the AppImageConfig API. This kernel is shown to users before the image starts.
+     *       After the image runs, all kernels are visible in Code Editor.</p>
+     * @public
+     */
+    CodeEditorAppImageConfig?: CodeEditorAppImageConfig;
+}
+/**
+ * @public
+ */
+export interface CreateAppImageConfigResponse {
+    /**
+     * <p>The ARN of the AppImageConfig.</p>
+     * @public
+     */
+    AppImageConfigArn?: string;
+}
+/**
+ * @public
+ */
+export interface CreateArtifactRequest {
+    /**
+     * <p>The name of the artifact. Must be unique to your account in an Amazon Web Services Region.</p>
+     * @public
+     */
+    ArtifactName?: string;
+    /**
+     * <p>The ID, ID type, and URI of the source.</p>
+     * @public
+     */
+    Source: ArtifactSource | undefined;
+    /**
+     * <p>The artifact type.</p>
+     * @public
+     */
+    ArtifactType: string | undefined;
+    /**
+     * <p>A list of properties to add to the artifact.</p>
+     * @public
+     */
+    Properties?: Record<string, string>;
+    /**
+     * <p>Metadata properties of the tracking entity, trial, or trial component.</p>
+     * @public
+     */
+    MetadataProperties?: MetadataProperties;
+    /**
+     * <p>A list of tags to apply to the artifact.</p>
+     * @public
+     */
+    Tags?: Tag[];
+}
+/**
+ * @public
+ */
+export interface CreateArtifactResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the artifact.</p>
+     * @public
+     */
+    ArtifactArn?: string;
+}
+/**
+ * <p>Specifies how to generate the endpoint name for an automatic one-click Autopilot model
+ *          deployment.</p>
+ * @public
+ */
+export interface ModelDeployConfig {
+    /**
+     * <p>Set to <code>True</code> to automatically generate an endpoint name for a one-click
+     *          Autopilot model deployment; set to <code>False</code> otherwise. The default value is
+     *             <code>False</code>.</p>
+     *          <note>
+     *             <p>If you set <code>AutoGenerateEndpointName</code> to <code>True</code>, do not specify
+     *             the <code>EndpointName</code>; otherwise a 400 error is thrown.</p>
+     *          </note>
+     * @public
+     */
+    AutoGenerateEndpointName?: boolean;
+    /**
+     * <p>Specifies the endpoint name to use for a one-click Autopilot model deployment if the
+     *          endpoint name is not generated automatically.</p>
+     *          <note>
+     *             <p>Specify the <code>EndpointName</code> if and only if you set
+     *                <code>AutoGenerateEndpointName</code> to <code>False</code>; otherwise a 400 error is
+     *             thrown.</p>
+     *          </note>
+     * @public
+     */
+    EndpointName?: string;
+}
+/**
+ * @public
+ */
+export interface CreateAutoMLJobRequest {
+    /**
+     * <p>Identifies an Autopilot job. The name must be unique to your account and is case
+     *          insensitive.</p>
+     * @public
+     */
+    AutoMLJobName: string | undefined;
+    /**
+     * <p>An array of channel objects that describes the input data and its location. Each channel
+     *          is a named input source. Similar to <code>InputDataConfig</code> supported by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a>. Format(s) supported: CSV, Parquet. A
+     *          minimum of 500 rows is required for the training dataset. There is not a minimum number of
+     *          rows required for the validation dataset.</p>
+     * @public
+     */
+    InputDataConfig: AutoMLChannel[] | undefined;
+    /**
+     * <p>Provides information about encryption and the Amazon S3 output path needed to
+     *          store artifacts from an AutoML job. Format(s) supported: CSV.</p>
+     * @public
+     */
+    OutputDataConfig: AutoMLOutputDataConfig | undefined;
+    /**
+     * <p>Defines the type of supervised learning problem available for the candidates. For more
+     *          information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types">
+     *             SageMaker Autopilot problem types</a>.</p>
+     * @public
+     */
+    ProblemType?: ProblemType;
+    /**
+     * <p>Specifies a metric to minimize or maximize as the objective of a job. If not specified,
+     *          the default objective metric depends on the problem type. See <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html">AutoMLJobObjective</a> for the default values.</p>
+     * @public
+     */
+    AutoMLJobObjective?: AutoMLJobObjective;
+    /**
+     * <p>A collection of settings used to configure an AutoML job.</p>
+     * @public
+     */
+    AutoMLJobConfig?: AutoMLJobConfig;
+    /**
+     * <p>The ARN of the role that is used to access the data.</p>
+     * @public
+     */
+    RoleArn: string | undefined;
+    /**
+     * <p>Generates possible candidates without training the models. A candidate is a combination
+     *          of data preprocessors, algorithms, and algorithm parameter settings.</p>
+     * @public
+     */
+    GenerateCandidateDefinitionsOnly?: 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 ServicesResources</a>. Tag keys must be unique per
+     *          resource.</p>
+     * @public
+     */
+    Tags?: Tag[];
+    /**
+     * <p>Specifies how to generate the endpoint name for an automatic one-click Autopilot model
+     *          deployment.</p>
+     * @public
+     */
+    ModelDeployConfig?: ModelDeployConfig;
+}
 /**
  * @public
  */
@@ -168,6 +368,21 @@ export interface CreateClusterRequest {
      * @public
      */
     Tags?: Tag[];
+    /**
+     * <p>The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported
+     *          value is <code>"eks"</code>, which is to use an Amazon Elastic Kubernetes Service (EKS)
+     *          cluster as the orchestrator.</p>
+     * @public
+     */
+    Orchestrator?: ClusterOrchestrator;
+    /**
+     * <p>The node recovery mode for the SageMaker HyperPod cluster. When set to <code>Automatic</code>,
+     *          SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set
+     *          to <code>None</code>, cluster administrators will need to manually manage any faulty
+     *          cluster instances.</p>
+     * @public
+     */
+    NodeRecovery?: ClusterNodeRecovery;
 }
 /**
  * @public
@@ -1819,6 +2034,11 @@ export interface JupyterLabAppSettings {
      * @public
      */
     CodeRepositories?: CodeRepository[];
+    /**
+     * <p>Indicates whether idle shutdown is activated for JupyterLab applications.</p>
+     * @public
+     */
+    AppLifecycleManagement?: AppLifecycleManagement;
     /**
      * <p>The configuration parameters that specify the IAM roles assumed by the execution role of
      *             SageMaker (assumable roles) and the cluster instances or job execution environments
@@ -11644,126 +11864,6 @@ export interface CreatePresignedMlflowTrackingServerUrlRequest {
      */
     SessionExpirationDurationInSeconds?: number;
 }
-/**
- * @public
- */
-export interface CreatePresignedMlflowTrackingServerUrlResponse {
-    /**
-     * <p>A presigned URL with an authorization token.</p>
-     * @public
-     */
-    AuthorizedUrl?: string;
-}
-/**
- * @public
- */
-export interface CreatePresignedNotebookInstanceUrlInput {
-    /**
-     * <p>The name of the notebook instance.</p>
-     * @public
-     */
-    NotebookInstanceName: string | undefined;
-    /**
-     * <p>The duration of the session, in seconds. The default is 12 hours.</p>
-     * @public
-     */
-    SessionExpirationDurationInSeconds?: number;
-}
-/**
- * @public
- */
-export interface CreatePresignedNotebookInstanceUrlOutput {
-    /**
-     * <p>A JSON object that contains the URL string. </p>
-     * @public
-     */
-    AuthorizedUrl?: string;
-}
-/**
- * <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
- *       you call the following APIs:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
- *                </p>
- *             </li>
- *          </ul>
- * @public
- */
-export interface ExperimentConfig {
-    /**
-     * <p>The name of an existing experiment to associate with the trial component.</p>
-     * @public
-     */
-    ExperimentName?: string;
-    /**
-     * <p>The name of an existing trial to associate the trial component with. If not specified, a
-     *       new trial is created.</p>
-     * @public
-     */
-    TrialName?: string;
-    /**
-     * <p>The display name for the trial component. If this key isn't specified, the display name is
-     *       the trial component name.</p>
-     * @public
-     */
-    TrialComponentDisplayName?: string;
-    /**
-     * <p>The name of the experiment run to associate with the trial component.</p>
-     * @public
-     */
-    RunName?: string;
-}
-/**
- * @public
- * @enum
- */
-export declare const DataDistributionType: {
-    readonly FULLYREPLICATED: "FullyReplicated";
-    readonly SHARDEDBYS3KEY: "ShardedByS3Key";
-};
-/**
- * @public
- */
-export type DataDistributionType = (typeof DataDistributionType)[keyof typeof DataDistributionType];
-/**
- * @public
- * @enum
- */
-export declare const InputMode: {
-    readonly FILE: "File";
-    readonly PIPE: "Pipe";
-};
-/**
- * @public
- */
-export type InputMode = (typeof InputMode)[keyof typeof InputMode];
-/**
- * @public
- * @enum
- */
-export declare const RedshiftResultCompressionType: {
-    readonly BZIP2: "BZIP2";
-    readonly GZIP: "GZIP";
-    readonly NONE: "None";
-    readonly SNAPPY: "SNAPPY";
-    readonly ZSTD: "ZSTD";
-};
-/**
- * @public
- */
-export type RedshiftResultCompressionType = (typeof RedshiftResultCompressionType)[keyof typeof RedshiftResultCompressionType];
 /**
  * @internal
  */