@aws-sdk/client-sagemaker 3.541.0 → 3.545.0

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

@@ -4139,6 +4139,23 @@ export interface FileSystemConfig {
      */
     DefaultGid?: number;
 }
+/**
+ * <p>The configuration for the file system and kernels in a SageMaker image running as a Code Editor app.
+ *       The <code>FileSystemConfig</code> object is not supported.</p>
+ * @public
+ */
+export interface CodeEditorAppImageConfig {
+    /**
+     * <p>The Amazon Elastic File System storage configuration for a SageMaker image.</p>
+     * @public
+     */
+    FileSystemConfig?: FileSystemConfig;
+    /**
+     * <p>The configuration used to run the application image container.</p>
+     * @public
+     */
+    ContainerConfig?: ContainerConfig;
+}
 /**
  * <p>The configuration for the file system and kernels in a SageMaker image running as a JupyterLab app. The <code>FileSystemConfig</code> object is not supported.</p>
  * @public
@@ -4223,6 +4240,12 @@ export interface AppImageConfigDetails {
      * @public
      */
     JupyterLabAppImageConfig?: JupyterLabAppImageConfig;
+    /**
+     * <p>The configuration for the file system and the runtime,
+     *       such as the environment variables and entry point.</p>
+     * @public
+     */
+    CodeEditorAppImageConfig?: CodeEditorAppImageConfig;
 }
 /**
  * @public
@@ -8362,6 +8385,28 @@ export interface ClusterSummary {
      */
     ClusterStatus: ClusterStatus | undefined;
 }
+/**
+ * <p>A custom SageMaker image. For more information, see
+ *          <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html">Bring your own SageMaker image</a>.</p>
+ * @public
+ */
+export interface CustomImage {
+    /**
+     * <p>The name of the CustomImage. Must be unique to your account.</p>
+     * @public
+     */
+    ImageName: string | undefined;
+    /**
+     * <p>The version number of the CustomImage.</p>
+     * @public
+     */
+    ImageVersionNumber?: number;
+    /**
+     * <p>The name of the AppImageConfig.</p>
+     * @public
+     */
+    AppImageConfigName: string | undefined;
+}
 /**
  * <p>The Code Editor application settings.</p>
  *          <p>For more information about Code Editor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html">Get started with Code
@@ -8375,6 +8420,11 @@ export interface CodeEditorAppSettings {
      * @public
      */
     DefaultResourceSpec?: ResourceSpec;
+    /**
+     * <p>A list of custom SageMaker images that are configured to run as a Code Editor app.</p>
+     * @public
+     */
+    CustomImages?: CustomImage[];
     /**
      * <p>The Amazon Resource Name (ARN) of the Code Editor application
      *       lifecycle configuration.</p>
@@ -9680,6 +9730,13 @@ export interface CreateAppImageConfigRequest {
      * @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
@@ -10509,306 +10566,3 @@ export interface TargetPlatform {
      */
     Accelerator?: TargetPlatformAccelerator;
 }
-/**
- * <p>Contains information about the output location for the compiled model and the target
- *             device that the model runs on. <code>TargetDevice</code> and <code>TargetPlatform</code>
- *             are mutually exclusive, so you need to choose one between the two to specify your target
- *             device or platform. If you cannot find your device you want to use from the
- *                 <code>TargetDevice</code> list, use <code>TargetPlatform</code> to describe the
- *             platform of your edge device and <code>CompilerOptions</code> if there are specific
- *             settings that are required or recommended to use for particular TargetPlatform.</p>
- * @public
- */
-export interface OutputConfig {
-    /**
-     * <p>Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For
-     *             example, <code>s3://bucket-name/key-name-prefix</code>.</p>
-     * @public
-     */
-    S3OutputLocation: string | undefined;
-    /**
-     * <p>Identifies the target device or the machine learning instance that you want to run
-     *             your model on after the compilation has completed. Alternatively, you can specify OS,
-     *             architecture, and accelerator using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html">TargetPlatform</a>
-     *             fields. It can be used instead of <code>TargetPlatform</code>.</p>
-     *          <note>
-     *             <p>Currently <code>ml_trn1</code> is available only in US East (N. Virginia) Region,
-     *                 and <code>ml_inf2</code> is available only in US East (Ohio) Region.</p>
-     *          </note>
-     * @public
-     */
-    TargetDevice?: TargetDevice;
-    /**
-     * <p>Contains information about a target platform that you want your model to run on, such
-     *             as OS, architecture, and accelerators. It is an alternative of
-     *             <code>TargetDevice</code>.</p>
-     *          <p>The following examples show how to configure the <code>TargetPlatform</code> and
-     *                 <code>CompilerOptions</code> JSON strings for popular target platforms: </p>
-     *          <ul>
-     *             <li>
-     *                <p>Raspberry Pi 3 Model B+</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "LINUX", "Arch": "ARM_EABIHF"\},</code>
-     *                </p>
-     *                <p>
-     *                   <code> "CompilerOptions": \{'mattr': ['+neon']\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>Jetson TX2</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "LINUX", "Arch": "ARM64", "Accelerator":
-     *                         "NVIDIA"\},</code>
-     *                </p>
-     *                <p>
-     *                   <code> "CompilerOptions": \{'gpu-code': 'sm_62', 'trt-ver': '6.0.1',
-     *                         'cuda-ver': '10.0'\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>EC2 m5.2xlarge instance OS</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "LINUX", "Arch": "X86_64", "Accelerator":
-     *                         "NVIDIA"\},</code>
-     *                </p>
-     *                <p>
-     *                   <code> "CompilerOptions": \{'mcpu': 'skylake-avx512'\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>RK3399</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "LINUX", "Arch": "ARM64", "Accelerator":
-     *                         "MALI"\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>ARMv7 phone (CPU)</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "ANDROID", "Arch": "ARM_EABI"\},</code>
-     *                </p>
-     *                <p>
-     *                   <code> "CompilerOptions": \{'ANDROID_PLATFORM': 25, 'mattr':
-     *                     ['+neon']\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>ARMv8 phone (CPU)</p>
-     *                <p>
-     *                   <code>"TargetPlatform": \{"Os": "ANDROID", "Arch": "ARM64"\},</code>
-     *                </p>
-     *                <p>
-     *                   <code> "CompilerOptions": \{'ANDROID_PLATFORM': 29\}</code>
-     *                </p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    TargetPlatform?: TargetPlatform;
-    /**
-     * <p>Specifies additional parameters for compiler options in JSON format. The compiler
-     *             options are <code>TargetPlatform</code> specific. It is required for NVIDIA accelerators
-     *             and highly recommended for CPU compilations. For any other cases, it is optional to
-     *             specify <code>CompilerOptions.</code>
-     *          </p>
-     *          <ul>
-     *             <li>
-     *                <p>
-     *                   <code>DTYPE</code>: Specifies the data type for the input. When compiling for
-     *                         <code>ml_*</code> (except for <code>ml_inf</code>) instances using PyTorch
-     *                     framework, provide the data type (dtype) of the model's input.
-     *                         <code>"float32"</code> is used if <code>"DTYPE"</code> is not specified.
-     *                     Options for data type are:</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>float32: Use either <code>"float"</code> or
-     *                             <code>"float32"</code>.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>int64: Use either <code>"int64"</code> or <code>"long"</code>.</p>
-     *                   </li>
-     *                </ul>
-     *                <p> For example, <code>\{"dtype" : "float32"\}</code>.</p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>CPU</code>: Compilation for CPU supports the following compiler
-     *                     options.</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>mcpu</code>: CPU micro-architecture. For example, <code>\{'mcpu':
-     *                                 'skylake-avx512'\}</code>
-     *                      </p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>mattr</code>: CPU flags. For example, <code>\{'mattr': ['+neon',
-     *                                 '+vfpv4']\}</code>
-     *                      </p>
-     *                   </li>
-     *                </ul>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>ARM</code>: Details of ARM CPU compilations.</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>NEON</code>: NEON is an implementation of the Advanced SIMD
-     *                             extension used in ARMv7 processors.</p>
-     *                      <p>For example, add <code>\{'mattr': ['+neon']\}</code> to the compiler
-     *                             options if compiling for ARM 32-bit platform with the NEON
-     *                             support.</p>
-     *                   </li>
-     *                </ul>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>NVIDIA</code>: Compilation for NVIDIA GPU supports the following
-     *                     compiler options.</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>gpu_code</code>: Specifies the targeted architecture.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>trt-ver</code>: Specifies the TensorRT versions in x.y.z.
-     *                             format.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>cuda-ver</code>: Specifies the CUDA version in x.y
-     *                             format.</p>
-     *                   </li>
-     *                </ul>
-     *                <p>For example, <code>\{'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver':
-     *                         '10.1'\}</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>ANDROID</code>: Compilation for the Android OS supports the following
-     *                     compiler options:</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>ANDROID_PLATFORM</code>: Specifies the Android API levels.
-     *                             Available levels range from 21 to 29. For example,
-     *                                 <code>\{'ANDROID_PLATFORM': 28\}</code>.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>mattr</code>: Add <code>\{'mattr': ['+neon']\}</code> to compiler
-     *                             options if compiling for ARM 32-bit platform with NEON support.</p>
-     *                   </li>
-     *                </ul>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>INFERENTIA</code>: Compilation for target ml_inf1 uses compiler options
-     *                     passed in as a JSON string. For example, <code>"CompilerOptions": "\"--verbose 1
-     *                         --num-neuroncores 2 -O2\""</code>. </p>
-     *                <p>For information about supported compiler options, see <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide</a>. </p>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>CoreML</code>: Compilation for the CoreML <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html">OutputConfig</a>
-     *                   <code>TargetDevice</code> supports the following compiler options:</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>class_labels</code>: Specifies the classification labels file
-     *                             name inside input tar.gz file. For example, <code>\{"class_labels":
-     *                                 "imagenet_labels_1000.txt"\}</code>. Labels inside the txt file
-     *                             should be separated by newlines.</p>
-     *                   </li>
-     *                </ul>
-     *             </li>
-     *             <li>
-     *                <p>
-     *                   <code>EIA</code>: Compilation for the Elastic Inference Accelerator supports
-     *                     the following compiler options:</p>
-     *                <ul>
-     *                   <li>
-     *                      <p>
-     *                         <code>precision_mode</code>: Specifies the precision of compiled
-     *                             artifacts. Supported values are <code>"FP16"</code> and
-     *                                 <code>"FP32"</code>. Default is <code>"FP32"</code>.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>signature_def_key</code>: Specifies the signature to use for
-     *                             models in SavedModel format. Defaults is TensorFlow's default signature
-     *                             def key.</p>
-     *                   </li>
-     *                   <li>
-     *                      <p>
-     *                         <code>output_names</code>: Specifies a list of output tensor names for
-     *                             models in FrozenGraph format. Set at most one API field, either:
-     *                                 <code>signature_def_key</code> or <code>output_names</code>.</p>
-     *                   </li>
-     *                </ul>
-     *                <p>For example: <code>\{"precision_mode": "FP32", "output_names":
-     *                         ["output:0"]\}</code>
-     *                </p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    CompilerOptions?: string;
-    /**
-     * <p>The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker
-     *             uses to encrypt your output models with Amazon S3 server-side encryption after compilation
-     *             job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your
-     *             role's account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">KMS-Managed Encryption
-     *                 Keys</a> in the <i>Amazon Simple Storage Service Developer
-     *                 Guide.</i>
-     *          </p>
-     *          <p>The KmsKeyId can be any of the following formats: </p>
-     *          <ul>
-     *             <li>
-     *                <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>Key ARN:
-     *                         <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>Alias name: <code>alias/ExampleAlias</code>
-     *                </p>
-     *             </li>
-     *             <li>
-     *                <p>Alias name ARN:
-     *                         <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code>
-     *                </p>
-     *             </li>
-     *          </ul>
-     * @public
-     */
-    KmsKeyId?: string;
-}
-/**
- * <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> configuration object that specifies the VPC that you want the
- *             compilation jobs to connect to. For more information on controlling access to your Amazon S3
- *             buckets used for compilation job, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Give Amazon SageMaker Compilation Jobs Access to
- *                 Resources in Your Amazon VPC</a>.</p>
- * @public
- */
-export interface NeoVpcConfig {
-    /**
-     * <p>The VPC security group IDs. IDs have the form of <code>sg-xxxxxxxx</code>. Specify the
-     *             security groups for the VPC that is specified in the <code>Subnets</code> field.</p>
-     * @public
-     */
-    SecurityGroupIds: string[] | undefined;
-    /**
-     * <p>The ID of the subnets in the VPC that you want to connect the compilation job to for
-     *             accessing the model in Amazon S3.</p>
-     * @public
-     */
-    Subnets: string[] | undefined;
-}