From 4fa41b79af58bceb76c1658a26841e4f72e2ed55 Mon Sep 17 00:00:00 2001 From: awstools <awstools@amazon.com> Date: Wed, 4 Oct 2023 18:49:42 +0000 Subject: [PATCH] feat(client-sagemaker): Adding support for AdditionalS3DataSource, a data source used for training or inference that is in addition to the input dataset or model data. --- .../BatchDescribeModelPackageCommand.ts | 5 + .../src/commands/CreateAlgorithmCommand.ts | 10 + .../src/commands/CreateDeviceFleetCommand.ts | 2 +- .../src/commands/CreateModelPackageCommand.ts | 10 + .../src/commands/DescribeAlgorithmCommand.ts | 10 + .../commands/DescribeModelPackageCommand.ts | 10 + .../src/commands/SearchCommand.ts | 10 + .../src/commands/UpdateModelPackageCommand.ts | 5 + .../client-sagemaker/src/models/models_0.ts | 270 +++++------- .../client-sagemaker/src/models/models_1.ts | 152 +++++-- .../client-sagemaker/src/models/models_2.ts | 197 ++------- .../client-sagemaker/src/models/models_3.ts | 415 +++++++----------- .../client-sagemaker/src/models/models_4.ts | 267 ++++++++++- .../src/protocols/Aws_json1_1.ts | 19 +- codegen/sdk-codegen/aws-models/sagemaker.json | 71 ++- 15 files changed, 813 insertions(+), 640 deletions(-) diff --git a/clients/client-sagemaker/src/commands/BatchDescribeModelPackageCommand.ts b/clients/client-sagemaker/src/commands/BatchDescribeModelPackageCommand.ts index 4cdd58e4042f..eaaff6a2076f 100644 --- a/clients/client-sagemaker/src/commands/BatchDescribeModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/BatchDescribeModelPackageCommand.ts @@ -76,6 +76,11 @@ export interface BatchDescribeModelPackageCommandOutput extends BatchDescribeMod * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { // AdditionalS3DataSource + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ // TransformInstanceTypes diff --git a/clients/client-sagemaker/src/commands/CreateAlgorithmCommand.ts b/clients/client-sagemaker/src/commands/CreateAlgorithmCommand.ts index 8ff58e70759c..9b51ccd15dde 100644 --- a/clients/client-sagemaker/src/commands/CreateAlgorithmCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateAlgorithmCommand.ts @@ -107,6 +107,11 @@ export interface CreateAlgorithmCommandOutput extends CreateAlgorithmOutput, __M * MetricName: "STRING_VALUE", // required * }, * ], + * AdditionalS3DataSource: { // AdditionalS3DataSource + * S3DataType: "S3Object", // required + * S3Uri: "STRING_VALUE", // required + * CompressionType: "None" || "Gzip", + * }, * }, * InferenceSpecification: { // InferenceSpecification * Containers: [ // ModelPackageContainerDefinitionList // required @@ -125,6 +130,11 @@ export interface CreateAlgorithmCommandOutput extends CreateAlgorithmOutput, __M * Framework: "STRING_VALUE", * FrameworkVersion: "STRING_VALUE", * NearestModelName: "STRING_VALUE", + * AdditionalS3DataSource: { + * S3DataType: "S3Object", // required + * S3Uri: "STRING_VALUE", // required + * CompressionType: "None" || "Gzip", + * }, * }, * ], * SupportedTransformInstanceTypes: [ // TransformInstanceTypes diff --git a/clients/client-sagemaker/src/commands/CreateDeviceFleetCommand.ts b/clients/client-sagemaker/src/commands/CreateDeviceFleetCommand.ts index 02b043b609d7..e63ed1438204 100644 --- a/clients/client-sagemaker/src/commands/CreateDeviceFleetCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateDeviceFleetCommand.ts @@ -14,7 +14,7 @@ import { SMITHY_CONTEXT_KEY, } from "@smithy/types"; -import { CreateDeviceFleetRequest } from "../models/models_0"; +import { CreateDeviceFleetRequest } from "../models/models_1"; import { de_CreateDeviceFleetCommand, se_CreateDeviceFleetCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/CreateModelPackageCommand.ts b/clients/client-sagemaker/src/commands/CreateModelPackageCommand.ts index a7f4d55472b7..dd4711fe8a12 100644 --- a/clients/client-sagemaker/src/commands/CreateModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/CreateModelPackageCommand.ts @@ -84,6 +84,11 @@ export interface CreateModelPackageCommandOutput extends CreateModelPackageOutpu * Framework: "STRING_VALUE", * FrameworkVersion: "STRING_VALUE", * NearestModelName: "STRING_VALUE", + * AdditionalS3DataSource: { // AdditionalS3DataSource + * S3DataType: "S3Object", // required + * S3Uri: "STRING_VALUE", // required + * CompressionType: "None" || "Gzip", + * }, * }, * ], * SupportedTransformInstanceTypes: [ // TransformInstanceTypes @@ -251,6 +256,11 @@ export interface CreateModelPackageCommandOutput extends CreateModelPackageOutpu * Framework: "STRING_VALUE", * FrameworkVersion: "STRING_VALUE", * NearestModelName: "STRING_VALUE", + * AdditionalS3DataSource: { + * S3DataType: "S3Object", // required + * S3Uri: "STRING_VALUE", // required + * CompressionType: "None" || "Gzip", + * }, * }, * ], * SupportedTransformInstanceTypes: [ diff --git a/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts b/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts index 224c65684214..2b1131011b28 100644 --- a/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeAlgorithmCommand.ts @@ -114,6 +114,11 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmOutput, * // MetricName: "STRING_VALUE", // required * // }, * // ], + * // AdditionalS3DataSource: { // AdditionalS3DataSource + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // InferenceSpecification: { // InferenceSpecification * // Containers: [ // ModelPackageContainerDefinitionList // required @@ -132,6 +137,11 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmOutput, * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ // TransformInstanceTypes diff --git a/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts index eb7710e56ba7..513009ccf2e4 100644 --- a/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts @@ -76,6 +76,11 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { // AdditionalS3DataSource + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ // TransformInstanceTypes @@ -275,6 +280,11 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ diff --git a/clients/client-sagemaker/src/commands/SearchCommand.ts b/clients/client-sagemaker/src/commands/SearchCommand.ts index 0b8bd0c103a6..302da103dbf8 100644 --- a/clients/client-sagemaker/src/commands/SearchCommand.ts +++ b/clients/client-sagemaker/src/commands/SearchCommand.ts @@ -1083,6 +1083,11 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { // AdditionalS3DataSource + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ // TransformInstanceTypes @@ -1234,6 +1239,11 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * // Framework: "STRING_VALUE", * // FrameworkVersion: "STRING_VALUE", * // NearestModelName: "STRING_VALUE", + * // AdditionalS3DataSource: { + * // S3DataType: "S3Object", // required + * // S3Uri: "STRING_VALUE", // required + * // CompressionType: "None" || "Gzip", + * // }, * // }, * // ], * // SupportedTransformInstanceTypes: [ diff --git a/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts b/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts index 3403dd654e0d..a9a6dceaaf21 100644 --- a/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateModelPackageCommand.ts @@ -74,6 +74,11 @@ export interface UpdateModelPackageCommandOutput extends UpdateModelPackageOutpu * Framework: "STRING_VALUE", * FrameworkVersion: "STRING_VALUE", * NearestModelName: "STRING_VALUE", + * AdditionalS3DataSource: { // AdditionalS3DataSource + * S3DataType: "S3Object", // required + * S3Uri: "STRING_VALUE", // required + * CompressionType: "None" || "Gzip", + * }, * }, * ], * SupportedTransformInstanceTypes: [ // TransformInstanceTypes diff --git a/clients/client-sagemaker/src/models/models_0.ts b/clients/client-sagemaker/src/models/models_0.ts index b419b3f933dc..e2ca3bed040a 100644 --- a/clients/client-sagemaker/src/models/models_0.ts +++ b/clients/client-sagemaker/src/models/models_0.ts @@ -216,6 +216,62 @@ export class ResourceNotFound extends __BaseException { } } +/** + * @public + * @enum + */ +export const CompressionType = { + GZIP: "Gzip", + NONE: "None", +} as const; + +/** + * @public + */ +export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType]; + +/** + * @public + * @enum + */ +export const AdditionalS3DataSourceDataType = { + S3OBJECT: "S3Object", +} as const; + +/** + * @public + */ +export type AdditionalS3DataSourceDataType = + (typeof AdditionalS3DataSourceDataType)[keyof typeof AdditionalS3DataSourceDataType]; + +/** + * @public + * <p>A data source used for training or inference that is in addition to the input dataset + * or model data.</p> + */ +export interface AdditionalS3DataSource { + /** + * @public + * <p>The data type of the additional data source that you specify for use in inference or + * training. </p> + */ + S3DataType: AdditionalS3DataSourceDataType | string | undefined; + + /** + * @public + * <p>The uniform resource identifier (URI) used to identify an additional data source used + * in inference or training.</p> + */ + S3Uri: string | undefined; + + /** + * @public + * <p>The type of compression used for an additional data source used in inference or + * training. Specify <code>None</code> if your additional data source is not compressed.</p> + */ + CompressionType?: CompressionType | string; +} + /** * @public * <p>Input object for the model.</p> @@ -308,6 +364,13 @@ export interface ModelPackageContainerDefinition { * You can find a list of benchmarked models by calling <code>ListModelMetadata</code>.</p> */ NearestModelName?: string; + + /** + * @public + * <p>The additional data source that is used during inference in the Docker container for + * your model package.</p> + */ + AdditionalS3DataSource?: AdditionalS3DataSource; } /** @@ -1037,20 +1100,6 @@ export interface AlgorithmSummary { AlgorithmStatus: AlgorithmStatus | string | undefined; } -/** - * @public - * @enum - */ -export const CompressionType = { - GZIP: "Gzip", - NONE: "None", -} as const; - -/** - * @public - */ -export type CompressionType = (typeof CompressionType)[keyof typeof CompressionType]; - /** * @public * @enum @@ -1472,7 +1521,8 @@ export interface OutputDataConfig { /** * @public - * <p>The model output compression type. Select <code>None</code> to output an uncompressed model, recommended for large model outputs. Defaults to gzip.</p> + * <p>The model output compression type. Select <code>None</code> to output an uncompressed + * model, recommended for large model outputs. Defaults to gzip.</p> */ CompressionType?: OutputCompressionType | string; } @@ -6970,10 +7020,12 @@ export type CapacitySizeType = (typeof CapacitySizeType)[keyof typeof CapacitySi /** * @public - * <p>Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. - * You can specify your batches as either instance count or the overall percentage or your fleet.</p> - * <p>For a rollback strategy, if you don't specify the fields in this object, or if you set the <code>Value</code> to 100%, then SageMaker - * uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.</p> + * <p>Specifies the type and size of the endpoint capacity to activate for a blue/green + * deployment, a rolling deployment, or a rollback strategy. You can specify your batches + * as either instance count or the overall percentage or your fleet.</p> + * <p>For a rollback strategy, if you don't specify the fields in this object, or if you set + * the <code>Value</code> to 100%, then SageMaker uses a blue/green rollback strategy and rolls + * all traffic back to the blue fleet.</p> */ export interface CapacitySize { /** @@ -8615,32 +8667,32 @@ export interface S3ModelDataSource { * @public * <p>Specifies how the ML model data is prepared.</p> * <p>If you choose <code>Gzip</code> and choose <code>S3Object</code> as the value of - * <code>S3DataType</code>, <code>S3Uri</code> identifies an object that is a - * gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object - * during model deployment.</p> + * <code>S3DataType</code>, <code>S3Uri</code> identifies an object that is a + * gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during + * model deployment.</p> * <p>If you choose <code>None</code> and chooose <code>S3Object</code> as the value of - * <code>S3DataType</code>, <code>S3Uri</code> identifies an object that represents an + * <code>S3DataType</code>, <code>S3Uri</code> identifies an object that represents an * uncompressed ML model to deploy.</p> * <p>If you choose None and choose <code>S3Prefix</code> as the value of - * <code>S3DataType</code>, <code>S3Uri</code> identifies a key name prefix, under which - * all objects represents the uncompressed ML model to deploy.</p> + * <code>S3DataType</code>, <code>S3Uri</code> identifies a key name prefix, under + * which all objects represents the uncompressed ML model to deploy.</p> * <p>If you choose None, then SageMaker will follow rules below when creating model data files * under /opt/ml/model directory for use by your inference code:</p> * <ul> * <li> * <p>If you choose <code>S3Object</code> as the value of <code>S3DataType</code>, - * then SageMaker will split the key of the S3 object referenced by <code>S3Uri</code> by - * slash (/), and use the last part as the filename of the file holding the content - * of the S3 object.</p> + * then SageMaker will split the key of the S3 object referenced by <code>S3Uri</code> + * by slash (/), and use the last part as the filename of the file holding the + * content of the S3 object.</p> * </li> * <li> * <p>If you choose <code>S3Prefix</code> as the value of <code>S3DataType</code>, - * then for each S3 object under the key name pefix referenced by <code>S3Uri</code>, - * SageMaker will trim its key by the prefix, and use the remainder as the path - * (relative to <code>/opt/ml/model</code>) of the file holding the content of the - * S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as - * directory names and the last part as filename of the file holding the content of - * the S3 object.</p> + * then for each S3 object under the key name pefix referenced by + * <code>S3Uri</code>, SageMaker will trim its key by the prefix, and use the + * remainder as the path (relative to <code>/opt/ml/model</code>) of the file + * holding the content of the S3 object. SageMaker will split the remainder by slash + * (/), using intermediate parts as directory names and the last part as filename + * of the file holding the content of the S3 object.</p> * </li> * <li> * <p>Do not use any of the following as file names or directory names:</p> @@ -8663,21 +8715,21 @@ export interface S3ModelDataSource { * </ul> * </li> * <li> - * <p>Ambiguous file names will result in model deployment failure. For example, - * if your uncompressed ML model consists of two S3 objects - * <code>s3://mybucket/model/weights</code> and <code>s3://mybucket/model/weights/part1</code> - * and you specify <code>s3://mybucket/model/</code> as the value of <code>S3Uri</code> and - * <code>S3Prefix</code> as the value of <code>S3DataType</code>, then it will result in name - * clash between <code>/opt/ml/model/weights</code> (a regular file) and - * <code>/opt/ml/model/weights/</code> (a directory).</p> + * <p>Ambiguous file names will result in model deployment failure. For example, if + * your uncompressed ML model consists of two S3 objects + * <code>s3://mybucket/model/weights</code> and + * <code>s3://mybucket/model/weights/part1</code> and you specify + * <code>s3://mybucket/model/</code> as the value of <code>S3Uri</code> and + * <code>S3Prefix</code> as the value of <code>S3DataType</code>, then it will + * result in name clash between <code>/opt/ml/model/weights</code> (a regular file) + * and <code>/opt/ml/model/weights/</code> (a directory).</p> * </li> * <li> - * <p>Do not organize the model artifacts in - * <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html">S3 console using folders</a>. - * When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the - * folder name you provide. They key of the 0-byte object ends with a slash (/) which violates - * SageMaker restrictions on model artifact file names, leading to model deployment failure. - * </p> + * <p>Do not organize the model artifacts in <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html">S3 console using + * folders</a>. When you create a folder in S3 console, S3 creates a 0-byte + * object with a key set to the folder name you provide. They key of the 0-byte + * object ends with a slash (/) which violates SageMaker restrictions on model artifact + * file names, leading to model deployment failure. </p> * </li> * </ul> */ @@ -8686,8 +8738,8 @@ export interface S3ModelDataSource { /** * @public - * <p>Specifies the location of ML model data to deploy. If specified, you must specify - * one and only one of the available data sources.</p> + * <p>Specifies the location of ML model data to deploy. If specified, you must specify one + * and only one of the available data sources.</p> */ export interface ModelDataSource { /** @@ -8844,8 +8896,8 @@ export interface ContainerDefinition { * @public * <p>Specifies the location of ML model data to deploy.</p> * <note> - * <p>Currently you cannot use <code>ModelDataSource</code> in conjunction with - * SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker + * <p>Currently you cannot use <code>ModelDataSource</code> in conjunction with SageMaker + * batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker * Marketplace.</p> * </note> */ @@ -9350,6 +9402,12 @@ export interface TrainingSpecification { * metric in a hyperparameter tuning job.</p> */ SupportedTuningJobObjectiveMetrics?: HyperParameterTuningJobObjective[]; + + /** + * @public + * <p>The additional data source used during the training job.</p> + */ + AdditionalS3DataSource?: AdditionalS3DataSource; } /** @@ -11402,113 +11460,3 @@ export const EdgePresetDeploymentType = { * @public */ export type EdgePresetDeploymentType = (typeof EdgePresetDeploymentType)[keyof typeof EdgePresetDeploymentType]; - -/** - * @public - * <p>The output configuration.</p> - */ -export interface EdgeOutputConfig { - /** - * @public - * <p>The Amazon Simple Storage (S3) bucker URI.</p> - */ - S3OutputLocation: string | undefined; - - /** - * @public - * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume 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.</p> - */ - KmsKeyId?: string; - - /** - * @public - * <p>The deployment type SageMaker Edge Manager will create. - * Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</p> - */ - PresetDeploymentType?: EdgePresetDeploymentType | string; - - /** - * @public - * <p>The configuration used to create deployment artifacts. - * Specify configuration options with a JSON string. The available configuration options for each type are:</p> - * <ul> - * <li> - * <p> - * <code>ComponentName</code> (optional) - Name of the GreenGrass V2 component. If not specified, - * the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager - * packaging job.</p> - * </li> - * <li> - * <p> - * <code>ComponentDescription</code> (optional) - Description of the component.</p> - * </li> - * <li> - * <p> - * <code>ComponentVersion</code> (optional) - The version of the component.</p> - * <note> - * <p>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> - * major.minor.patch</i> number system. For example, version 1.0.0 represents the first - * major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</p> - * </note> - * </li> - * <li> - * <p> - * <code>PlatformOS</code> (optional) - The name of the operating system for the platform. - * Supported platforms include Windows and Linux.</p> - * </li> - * <li> - * <p> - * <code>PlatformArchitecture</code> (optional) - The processor architecture for the platform. </p> - * <p>Supported architectures Windows include: Windows32_x86, Windows64_x64.</p> - * <p>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</p> - * </li> - * </ul> - */ - PresetDeploymentConfig?: string; -} - -/** - * @public - */ -export interface CreateDeviceFleetRequest { - /** - * @public - * <p>The name of the fleet that the device belongs to.</p> - */ - DeviceFleetName: string | undefined; - - /** - * @public - * <p>The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).</p> - */ - RoleArn?: string; - - /** - * @public - * <p>A description of the fleet.</p> - */ - Description?: string; - - /** - * @public - * <p>The output configuration for storing sample data collected by the fleet.</p> - */ - OutputConfig: EdgeOutputConfig | undefined; - - /** - * @public - * <p>Creates tags for the specified fleet.</p> - */ - Tags?: Tag[]; - - /** - * @public - * <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. - * The name of the role alias generated will match this pattern: - * "SageMakerEdge-\{DeviceFleetName\}".</p> - * <p>For example, if your device fleet is called "demo-fleet", the name of - * the role alias will be "SageMakerEdge-demo-fleet".</p> - */ - EnableIotRoleAlias?: boolean; -} diff --git a/clients/client-sagemaker/src/models/models_1.ts b/clients/client-sagemaker/src/models/models_1.ts index 4334aa8d143b..ecd37b640e64 100644 --- a/clients/client-sagemaker/src/models/models_1.ts +++ b/clients/client-sagemaker/src/models/models_1.ts @@ -43,7 +43,7 @@ import { ContentClassifier, ContinuousParameterRange, ConvergenceDetected, - EdgeOutputConfig, + EdgePresetDeploymentType, EndpointInput, HyperParameterScalingType, HyperParameterTuningJobObjective, @@ -77,6 +77,116 @@ import { VpcConfig, } from "./models_0"; +/** + * @public + * <p>The output configuration.</p> + */ +export interface EdgeOutputConfig { + /** + * @public + * <p>The Amazon Simple Storage (S3) bucker URI.</p> + */ + S3OutputLocation: string | undefined; + + /** + * @public + * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume 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.</p> + */ + KmsKeyId?: string; + + /** + * @public + * <p>The deployment type SageMaker Edge Manager will create. + * Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</p> + */ + PresetDeploymentType?: EdgePresetDeploymentType | string; + + /** + * @public + * <p>The configuration used to create deployment artifacts. + * Specify configuration options with a JSON string. The available configuration options for each type are:</p> + * <ul> + * <li> + * <p> + * <code>ComponentName</code> (optional) - Name of the GreenGrass V2 component. If not specified, + * the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager + * packaging job.</p> + * </li> + * <li> + * <p> + * <code>ComponentDescription</code> (optional) - Description of the component.</p> + * </li> + * <li> + * <p> + * <code>ComponentVersion</code> (optional) - The version of the component.</p> + * <note> + * <p>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> + * major.minor.patch</i> number system. For example, version 1.0.0 represents the first + * major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</p> + * </note> + * </li> + * <li> + * <p> + * <code>PlatformOS</code> (optional) - The name of the operating system for the platform. + * Supported platforms include Windows and Linux.</p> + * </li> + * <li> + * <p> + * <code>PlatformArchitecture</code> (optional) - The processor architecture for the platform. </p> + * <p>Supported architectures Windows include: Windows32_x86, Windows64_x64.</p> + * <p>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</p> + * </li> + * </ul> + */ + PresetDeploymentConfig?: string; +} + +/** + * @public + */ +export interface CreateDeviceFleetRequest { + /** + * @public + * <p>The name of the fleet that the device belongs to.</p> + */ + DeviceFleetName: string | undefined; + + /** + * @public + * <p>The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).</p> + */ + RoleArn?: string; + + /** + * @public + * <p>A description of the fleet.</p> + */ + Description?: string; + + /** + * @public + * <p>The output configuration for storing sample data collected by the fleet.</p> + */ + OutputConfig: EdgeOutputConfig | undefined; + + /** + * @public + * <p>Creates tags for the specified fleet.</p> + */ + Tags?: Tag[]; + + /** + * @public + * <p>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. + * The name of the role alias generated will match this pattern: + * "SageMakerEdge-\{DeviceFleetName\}".</p> + * <p>For example, if your device fleet is called "demo-fleet", the name of + * the role alias will be "SageMakerEdge-demo-fleet".</p> + */ + EnableIotRoleAlias?: boolean; +} + /** * @public * <p>The JupyterServer app settings.</p> @@ -837,7 +947,8 @@ export interface RollingUpdatePolicy { /** * @public - * <p>The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.</p> + * <p>The length of the baking period, during which SageMaker monitors alarms for each batch on + * the new fleet.</p> */ WaitIntervalInSeconds: number | undefined; @@ -850,9 +961,10 @@ export interface RollingUpdatePolicy { /** * @public * <p>Batch size for rollback to the old endpoint fleet. Each rolling step to provision - * capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new - * endpoint fleet. If this field is absent, the default value will be set to 100% of total - * capacity which means to bring up the whole capacity of the old fleet at once during rollback.</p> + * capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the + * new endpoint fleet. If this field is absent, the default value will be set to 100% of + * total capacity which means to bring up the whole capacity of the old fleet at once + * during rollback.</p> */ RollbackMaximumBatchSize?: CapacitySize; } @@ -3312,7 +3424,8 @@ export interface HyperParameterTuningInstanceConfig { * @public * <p>The number of instances of the type specified by <code>InstanceType</code>. Choose an * instance count larger than 1 for distributed training algorithms. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html">Step 2: - * Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK</a> for more information.</p> + * Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK</a> for more + * information.</p> */ InstanceCount: number | undefined; @@ -11873,33 +11986,6 @@ export interface DeleteDeviceFleetRequest { DeviceFleetName: string | undefined; } -/** - * @public - * @enum - */ -export const RetentionType = { - Delete: "Delete", - Retain: "Retain", -} as const; - -/** - * @public - */ -export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType]; - -/** - * @public - * <p>The retention policy for data stored on an Amazon Elastic File System (EFS) volume.</p> - */ -export interface RetentionPolicy { - /** - * @public - * <p>The default is <code>Retain</code>, which specifies to keep the data stored on the EFS volume.</p> - * <p>Specify <code>Delete</code> to delete the data stored on the EFS volume.</p> - */ - HomeEfsFileSystem?: RetentionType | string; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 98e2eda27fff..50fcefa903ee 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -46,7 +46,6 @@ import { DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, - EdgeOutputConfig, EdgePresetDeploymentType, GitConfig, HyperParameterTuningJobObjectiveType, @@ -95,6 +94,7 @@ import { DriftCheckBaselines, EdgeDeploymentConfig, EdgeDeploymentModelConfig, + EdgeOutputConfig, EndpointInfo, ExecutionRoleIdentityConfig, ExperimentConfig, @@ -159,7 +159,6 @@ import { RecommendationJobInputConfig, RecommendationJobStoppingConditions, RecommendationJobType, - RetentionPolicy, RetryStrategy, RootAccess, RuleEvaluationStatus, @@ -178,6 +177,33 @@ import { VendorGuidance, } from "./models_1"; +/** + * @public + * @enum + */ +export const RetentionType = { + Delete: "Delete", + Retain: "Retain", +} as const; + +/** + * @public + */ +export type RetentionType = (typeof RetentionType)[keyof typeof RetentionType]; + +/** + * @public + * <p>The retention policy for data stored on an Amazon Elastic File System (EFS) volume.</p> + */ +export interface RetentionPolicy { + /** + * @public + * <p>The default is <code>Retain</code>, which specifies to keep the data stored on the EFS volume.</p> + * <p>Specify <code>Delete</code> to delete the data stored on the EFS volume.</p> + */ + HomeEfsFileSystem?: RetentionType | string; +} + /** * @public */ @@ -3126,10 +3152,11 @@ export interface DescribeEndpointOutput { * </li> * <li> * <p> - * <code>UpdateRollbackFailed</code>: Both the rolling deployment and auto-rollback failed. Your endpoint - * is in service with a mix of the old and new endpoint configurations. For information about how to remedy - * this issue and restore the endpoint's status to <code>InService</code>, see - * <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling Deployments</a>.</p> + * <code>UpdateRollbackFailed</code>: Both the rolling deployment and + * auto-rollback failed. Your endpoint is in service with a mix of the old and new + * endpoint configurations. For information about how to remedy this issue and + * restore the endpoint's status to <code>InService</code>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html">Rolling + * Deployments</a>.</p> * </li> * </ul> */ @@ -7391,10 +7418,6 @@ export interface SelectiveExecutionConfig { * Used to copy input collaterals needed for the selected steps to run. * The execution status of the pipeline can be either <code>Failed</code> * or <code>Success</code>.</p> - * <p>This field is required if the steps you specify for - * <code>SelectedSteps</code> depend on output collaterals from any non-specified pipeline - * steps. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html">Selective - * Execution for Pipeline Steps</a>.</p> */ SourcePipelineExecutionArn?: string; @@ -10833,160 +10856,6 @@ export const EndpointSortKey = { */ export type EndpointSortKey = (typeof EndpointSortKey)[keyof typeof EndpointSortKey]; -/** - * @public - * <p>Provides summary information for an endpoint.</p> - */ -export interface EndpointSummary { - /** - * @public - * <p>The name of the endpoint.</p> - */ - EndpointName: string | undefined; - - /** - * @public - * <p>The Amazon Resource Name (ARN) of the endpoint.</p> - */ - EndpointArn: string | undefined; - - /** - * @public - * <p>A timestamp that shows when the endpoint was created.</p> - */ - CreationTime: Date | undefined; - - /** - * @public - * <p>A timestamp that shows when the endpoint was last modified.</p> - */ - LastModifiedTime: Date | undefined; - - /** - * @public - * <p>The status of the endpoint.</p> - * <ul> - * <li> - * <p> - * <code>OutOfService</code>: Endpoint is not available to take incoming - * requests.</p> - * </li> - * <li> - * <p> - * <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p> - * </li> - * <li> - * <p> - * <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p> - * </li> - * <li> - * <p> - * <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be - * updated or deleted or re-scaled until it has completed. This maintenance - * operation does not change any customer-specified values such as VPC config, KMS - * encryption, model, instance type, or instance count.</p> - * </li> - * <li> - * <p> - * <code>RollingBack</code>: Endpoint fails to scale up or down or change its - * variant weight and is in the process of rolling back to its previous - * configuration. Once the rollback completes, endpoint returns to an - * <code>InService</code> status. This transitional status only applies to an - * endpoint that has autoscaling enabled and is undergoing variant weight or - * capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called - * explicitly.</p> - * </li> - * <li> - * <p> - * <code>InService</code>: Endpoint is available to process incoming - * requests.</p> - * </li> - * <li> - * <p> - * <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p> - * </li> - * <li> - * <p> - * <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use - * <code>DescribeEndpointOutput$FailureReason</code> for information about the - * failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a - * failed endpoint.</p> - * </li> - * </ul> - * <p>To get a list of endpoints with a specified status, use the <code>StatusEquals</code> - * filter with a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html">ListEndpoints</a>.</p> - */ - EndpointStatus: EndpointStatus | string | undefined; -} - -/** - * @public - * <p>The properties of an experiment as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p> - */ -export interface Experiment { - /** - * @public - * <p>The name of the experiment.</p> - */ - ExperimentName?: string; - - /** - * @public - * <p>The Amazon Resource Name (ARN) of the experiment.</p> - */ - ExperimentArn?: string; - - /** - * @public - * <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, - * <code>ExperimentName</code> is displayed.</p> - */ - DisplayName?: string; - - /** - * @public - * <p>The source of the experiment.</p> - */ - Source?: ExperimentSource; - - /** - * @public - * <p>The description of the experiment.</p> - */ - Description?: string; - - /** - * @public - * <p>When the experiment was created.</p> - */ - CreationTime?: Date; - - /** - * @public - * <p>Who created the experiment.</p> - */ - CreatedBy?: UserContext; - - /** - * @public - * <p>When the experiment was last modified.</p> - */ - LastModifiedTime?: Date; - - /** - * @public - * <p>Information about the user who created or modified an experiment, trial, trial - * component, lineage group, project, or model card.</p> - */ - LastModifiedBy?: UserContext; - - /** - * @public - * <p>The list of tags that are associated with the experiment. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p> - */ - Tags?: Tag[]; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index 3a312c1368e6..36066061c67f 100644 --- a/clients/client-sagemaker/src/models/models_3.ts +++ b/clients/client-sagemaker/src/models/models_3.ts @@ -3,7 +3,6 @@ import { SENSITIVE_STRING } from "@smithy/smithy-client"; import { ActionSummary, - AdditionalInferenceSpecificationDefinition, AgentVersion, AlgorithmSortBy, AlgorithmSummary, @@ -35,9 +34,6 @@ import { ConditionStepMetadata, ContainerDefinition, ContextSummary, - EdgeOutputConfig, - InferenceSpecification, - MetadataProperties, ModelApprovalStatus, ModelPackageStatus, OutputParameter, @@ -51,7 +47,7 @@ import { import { _InstanceType, DataProcessing, - DriftCheckBaselines, + EdgeOutputConfig, ExperimentConfig, FeatureDefinition, FeatureType, @@ -66,16 +62,12 @@ import { ModelCardSecurityConfig, ModelCardStatus, ModelClientConfig, - ModelMetrics, - ModelPackageValidationSpecification, MonitoringScheduleConfig, MonitoringType, OfflineStoreConfig, OnlineStoreConfig, RecommendationJobType, ResourceLimits, - SkipModelValidation, - SourceAlgorithmSpecification, StudioLifecycleConfigAppType, TrialComponentStatus, } from "./models_1"; @@ -97,7 +89,6 @@ import { EndpointOutputConfiguration, EndpointSortKey, EndpointStatus, - EndpointSummary, ExecutionStatus, ExperimentSource, FeatureGroupStatus, @@ -121,7 +112,6 @@ import { ModelCardExportJobStatus, ModelConfiguration, ModelPackageGroupStatus, - ModelPackageStatusDetails, MonitoringExecutionSummary, NotebookInstanceStatus, ObjectiveStatusCounters, @@ -147,6 +137,160 @@ import { Workteam, } from "./models_2"; +/** + * @public + * <p>Provides summary information for an endpoint.</p> + */ +export interface EndpointSummary { + /** + * @public + * <p>The name of the endpoint.</p> + */ + EndpointName: string | undefined; + + /** + * @public + * <p>The Amazon Resource Name (ARN) of the endpoint.</p> + */ + EndpointArn: string | undefined; + + /** + * @public + * <p>A timestamp that shows when the endpoint was created.</p> + */ + CreationTime: Date | undefined; + + /** + * @public + * <p>A timestamp that shows when the endpoint was last modified.</p> + */ + LastModifiedTime: Date | undefined; + + /** + * @public + * <p>The status of the endpoint.</p> + * <ul> + * <li> + * <p> + * <code>OutOfService</code>: Endpoint is not available to take incoming + * requests.</p> + * </li> + * <li> + * <p> + * <code>Creating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> is executing.</p> + * </li> + * <li> + * <p> + * <code>Updating</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html">UpdateEndpoint</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> is executing.</p> + * </li> + * <li> + * <p> + * <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be + * updated or deleted or re-scaled until it has completed. This maintenance + * operation does not change any customer-specified values such as VPC config, KMS + * encryption, model, instance type, or instance count.</p> + * </li> + * <li> + * <p> + * <code>RollingBack</code>: Endpoint fails to scale up or down or change its + * variant weight and is in the process of rolling back to its previous + * configuration. Once the rollback completes, endpoint returns to an + * <code>InService</code> status. This transitional status only applies to an + * endpoint that has autoscaling enabled and is undergoing variant weight or + * capacity changes as part of an <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> call or when the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html">UpdateEndpointWeightsAndCapacities</a> operation is called + * explicitly.</p> + * </li> + * <li> + * <p> + * <code>InService</code>: Endpoint is available to process incoming + * requests.</p> + * </li> + * <li> + * <p> + * <code>Deleting</code>: <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is executing.</p> + * </li> + * <li> + * <p> + * <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use + * <code>DescribeEndpointOutput$FailureReason</code> for information about the + * failure. <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html">DeleteEndpoint</a> is the only operation that can be performed on a + * failed endpoint.</p> + * </li> + * </ul> + * <p>To get a list of endpoints with a specified status, use the <code>StatusEquals</code> + * filter with a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListEndpoints.html">ListEndpoints</a>.</p> + */ + EndpointStatus: EndpointStatus | string | undefined; +} + +/** + * @public + * <p>The properties of an experiment as returned by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API.</p> + */ +export interface Experiment { + /** + * @public + * <p>The name of the experiment.</p> + */ + ExperimentName?: string; + + /** + * @public + * <p>The Amazon Resource Name (ARN) of the experiment.</p> + */ + ExperimentArn?: string; + + /** + * @public + * <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, + * <code>ExperimentName</code> is displayed.</p> + */ + DisplayName?: string; + + /** + * @public + * <p>The source of the experiment.</p> + */ + Source?: ExperimentSource; + + /** + * @public + * <p>The description of the experiment.</p> + */ + Description?: string; + + /** + * @public + * <p>When the experiment was created.</p> + */ + CreationTime?: Date; + + /** + * @public + * <p>Who created the experiment.</p> + */ + CreatedBy?: UserContext; + + /** + * @public + * <p>When the experiment was last modified.</p> + */ + LastModifiedTime?: Date; + + /** + * @public + * <p>Information about the user who created or modified an experiment, trial, trial + * component, lineage group, project, or model card.</p> + */ + LastModifiedBy?: UserContext; + + /** + * @public + * <p>The list of tags that are associated with the experiment. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p> + */ + Tags?: Tag[]; +} + /** * @public * <p>A summary of the properties of an experiment. To get the complete set of properties, call @@ -10571,255 +10715,6 @@ export interface ModelDashboardMonitoringSchedule { LastMonitoringExecutionSummary?: MonitoringExecutionSummary; } -/** - * @public - * <p>A model displayed in the Amazon SageMaker Model Dashboard.</p> - */ -export interface ModelDashboardModel { - /** - * @public - * <p>A model displayed in the Model Dashboard.</p> - */ - Model?: Model; - - /** - * @public - * <p>The endpoints that host a model.</p> - */ - Endpoints?: ModelDashboardEndpoint[]; - - /** - * @public - * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch - * Transform</a>.</p> - */ - LastBatchTransformJob?: TransformJob; - - /** - * @public - * <p>The monitoring schedules for a model.</p> - */ - MonitoringSchedules?: ModelDashboardMonitoringSchedule[]; - - /** - * @public - * <p>The model card for a model.</p> - */ - ModelCard?: ModelDashboardModelCard; -} - -/** - * @public - * <p>A versioned model that can be deployed for SageMaker inference.</p> - */ -export interface ModelPackage { - /** - * @public - * <p>The name of the model.</p> - */ - ModelPackageName?: string; - - /** - * @public - * <p>The model group to which the model belongs.</p> - */ - ModelPackageGroupName?: string; - - /** - * @public - * <p>The version number of a versioned model.</p> - */ - ModelPackageVersion?: number; - - /** - * @public - * <p>The Amazon Resource Name (ARN) of the model package.</p> - */ - ModelPackageArn?: string; - - /** - * @public - * <p>The description of the model package.</p> - */ - ModelPackageDescription?: string; - - /** - * @public - * <p>The time that the model package was created.</p> - */ - CreationTime?: Date; - - /** - * @public - * <p>Defines how to perform inference generation after a training job is run.</p> - */ - InferenceSpecification?: InferenceSpecification; - - /** - * @public - * <p>A list of algorithms that were used to create a model package.</p> - */ - SourceAlgorithmSpecification?: SourceAlgorithmSpecification; - - /** - * @public - * <p>Specifies batch transform jobs that SageMaker runs to validate your model package.</p> - */ - ValidationSpecification?: ModelPackageValidationSpecification; - - /** - * @public - * <p>The status of the model package. This can be one of the following values.</p> - * <ul> - * <li> - * <p> - * <code>PENDING</code> - The model package is pending being created.</p> - * </li> - * <li> - * <p> - * <code>IN_PROGRESS</code> - The model package is in the process of being - * created.</p> - * </li> - * <li> - * <p> - * <code>COMPLETED</code> - The model package was successfully created.</p> - * </li> - * <li> - * <p> - * <code>FAILED</code> - The model package failed.</p> - * </li> - * <li> - * <p> - * <code>DELETING</code> - The model package is in the process of being deleted.</p> - * </li> - * </ul> - */ - ModelPackageStatus?: ModelPackageStatus | string; - - /** - * @public - * <p>Specifies the validation and image scan statuses of the model package.</p> - */ - ModelPackageStatusDetails?: ModelPackageStatusDetails; - - /** - * @public - * <p>Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For - * information about listing model packages on Amazon Web Services Marketplace, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html">List Your - * Algorithm or Model Package on Amazon Web Services Marketplace</a>.</p> - */ - CertifyForMarketplace?: boolean; - - /** - * @public - * <p>The approval status of the model. This can be one of the following values.</p> - * <ul> - * <li> - * <p> - * <code>APPROVED</code> - The model is approved</p> - * </li> - * <li> - * <p> - * <code>REJECTED</code> - The model is rejected.</p> - * </li> - * <li> - * <p> - * <code>PENDING_MANUAL_APPROVAL</code> - The model is waiting for manual - * approval.</p> - * </li> - * </ul> - */ - ModelApprovalStatus?: ModelApprovalStatus | string; - - /** - * @public - * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p> - */ - CreatedBy?: UserContext; - - /** - * @public - * <p>Metadata properties of the tracking entity, trial, or trial component.</p> - */ - MetadataProperties?: MetadataProperties; - - /** - * @public - * <p>Metrics for the model.</p> - */ - ModelMetrics?: ModelMetrics; - - /** - * @public - * <p>The last time the model package was modified.</p> - */ - LastModifiedTime?: Date; - - /** - * @public - * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p> - */ - LastModifiedBy?: UserContext; - - /** - * @public - * <p>A description provided when the model approval is set.</p> - */ - ApprovalDescription?: string; - - /** - * @public - * <p>The machine learning domain of your model package and its components. Common - * machine learning domains include computer vision and natural language processing.</p> - */ - Domain?: string; - - /** - * @public - * <p>The machine learning task your model package accomplishes. Common machine - * learning tasks include object detection and image classification.</p> - */ - Task?: string; - - /** - * @public - * <p>The Amazon Simple Storage Service path where the sample payload are stored. This path must point to - * a single gzip compressed tar archive (.tar.gz suffix).</p> - */ - SamplePayloadUrl?: string; - - /** - * @public - * <p>An array of additional Inference Specification objects.</p> - */ - AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; - - /** - * @public - * <p>A list of the tags associated with the model package. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services - * resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p> - */ - Tags?: Tag[]; - - /** - * @public - * <p>The metadata properties for the model package. </p> - */ - CustomerMetadataProperties?: Record<string, string>; - - /** - * @public - * <p>Represents the drift check baselines that can be used when the model monitor is set using the model package.</p> - */ - DriftCheckBaselines?: DriftCheckBaselines; - - /** - * @public - * <p>Indicates if you want to skip model validation.</p> - */ - SkipModelValidation?: SkipModelValidation | string; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts index 4c88031ab71f..fe5df60c32c2 100644 --- a/clients/client-sagemaker/src/models/models_4.ts +++ b/clients/client-sagemaker/src/models/models_4.ts @@ -10,10 +10,11 @@ import { BooleanOperator, Channel, CheckpointConfig, - EdgeOutputConfig, + InferenceSpecification, KernelGatewayImageConfig, MetadataProperties, ModelApprovalStatus, + ModelPackageStatus, OutputDataConfig, OutputParameter, ResourceConfig, @@ -30,6 +31,8 @@ import { DebugRuleEvaluationStatus, DefaultSpaceSettings, DeploymentConfig, + DriftCheckBaselines, + EdgeOutputConfig, ExperimentConfig, FeatureDefinition, InferenceExperimentDataStorageConfig, @@ -38,6 +41,8 @@ import { JobType, MemberDefinition, ModelCardStatus, + ModelMetrics, + ModelPackageValidationSpecification, ModelVariantConfig, MonitoringScheduleConfig, NetworkConfig, @@ -60,6 +65,8 @@ import { RootAccess, ServiceCatalogProvisioningDetails, ShadowModeConfig, + SkipModelValidation, + SourceAlgorithmSpecification, SourceIpConfig, SpaceSettings, TensorBoardOutputConfig, @@ -79,11 +86,11 @@ import { DomainSettingsForUpdate, Edge, Endpoint, - Experiment, FeatureParameter, MetricData, ModelArtifacts, ModelPackageGroupStatus, + ModelPackageStatusDetails, PipelineExecutionStatus, PipelineExperimentConfig, PipelineStatus, @@ -101,6 +108,7 @@ import { Workteam, } from "./models_2"; import { + Experiment, FeatureGroup, FeatureMetadata, Filter, @@ -108,15 +116,266 @@ import { HyperParameterTuningJobSearchEntity, InferenceExperimentStopDesiredState, LineageType, + Model, ModelCard, ModelCardFilterSensitiveLog, - ModelDashboardModel, - ModelPackage, + ModelDashboardEndpoint, + ModelDashboardModelCard, + ModelDashboardMonitoringSchedule, Parameter, ResourceType, TransformJob, } from "./models_3"; +/** + * @public + * <p>A model displayed in the Amazon SageMaker Model Dashboard.</p> + */ +export interface ModelDashboardModel { + /** + * @public + * <p>A model displayed in the Model Dashboard.</p> + */ + Model?: Model; + + /** + * @public + * <p>The endpoints that host a model.</p> + */ + Endpoints?: ModelDashboardEndpoint[]; + + /** + * @public + * <p>A batch transform job. For information about SageMaker batch transform, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Use Batch + * Transform</a>.</p> + */ + LastBatchTransformJob?: TransformJob; + + /** + * @public + * <p>The monitoring schedules for a model.</p> + */ + MonitoringSchedules?: ModelDashboardMonitoringSchedule[]; + + /** + * @public + * <p>The model card for a model.</p> + */ + ModelCard?: ModelDashboardModelCard; +} + +/** + * @public + * <p>A versioned model that can be deployed for SageMaker inference.</p> + */ +export interface ModelPackage { + /** + * @public + * <p>The name of the model.</p> + */ + ModelPackageName?: string; + + /** + * @public + * <p>The model group to which the model belongs.</p> + */ + ModelPackageGroupName?: string; + + /** + * @public + * <p>The version number of a versioned model.</p> + */ + ModelPackageVersion?: number; + + /** + * @public + * <p>The Amazon Resource Name (ARN) of the model package.</p> + */ + ModelPackageArn?: string; + + /** + * @public + * <p>The description of the model package.</p> + */ + ModelPackageDescription?: string; + + /** + * @public + * <p>The time that the model package was created.</p> + */ + CreationTime?: Date; + + /** + * @public + * <p>Defines how to perform inference generation after a training job is run.</p> + */ + InferenceSpecification?: InferenceSpecification; + + /** + * @public + * <p>A list of algorithms that were used to create a model package.</p> + */ + SourceAlgorithmSpecification?: SourceAlgorithmSpecification; + + /** + * @public + * <p>Specifies batch transform jobs that SageMaker runs to validate your model package.</p> + */ + ValidationSpecification?: ModelPackageValidationSpecification; + + /** + * @public + * <p>The status of the model package. This can be one of the following values.</p> + * <ul> + * <li> + * <p> + * <code>PENDING</code> - The model package is pending being created.</p> + * </li> + * <li> + * <p> + * <code>IN_PROGRESS</code> - The model package is in the process of being + * created.</p> + * </li> + * <li> + * <p> + * <code>COMPLETED</code> - The model package was successfully created.</p> + * </li> + * <li> + * <p> + * <code>FAILED</code> - The model package failed.</p> + * </li> + * <li> + * <p> + * <code>DELETING</code> - The model package is in the process of being deleted.</p> + * </li> + * </ul> + */ + ModelPackageStatus?: ModelPackageStatus | string; + + /** + * @public + * <p>Specifies the validation and image scan statuses of the model package.</p> + */ + ModelPackageStatusDetails?: ModelPackageStatusDetails; + + /** + * @public + * <p>Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For + * information about listing model packages on Amazon Web Services Marketplace, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-mkt-list.html">List Your + * Algorithm or Model Package on Amazon Web Services Marketplace</a>.</p> + */ + CertifyForMarketplace?: boolean; + + /** + * @public + * <p>The approval status of the model. This can be one of the following values.</p> + * <ul> + * <li> + * <p> + * <code>APPROVED</code> - The model is approved</p> + * </li> + * <li> + * <p> + * <code>REJECTED</code> - The model is rejected.</p> + * </li> + * <li> + * <p> + * <code>PENDING_MANUAL_APPROVAL</code> - The model is waiting for manual + * approval.</p> + * </li> + * </ul> + */ + ModelApprovalStatus?: ModelApprovalStatus | string; + + /** + * @public + * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p> + */ + CreatedBy?: UserContext; + + /** + * @public + * <p>Metadata properties of the tracking entity, trial, or trial component.</p> + */ + MetadataProperties?: MetadataProperties; + + /** + * @public + * <p>Metrics for the model.</p> + */ + ModelMetrics?: ModelMetrics; + + /** + * @public + * <p>The last time the model package was modified.</p> + */ + LastModifiedTime?: Date; + + /** + * @public + * <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.</p> + */ + LastModifiedBy?: UserContext; + + /** + * @public + * <p>A description provided when the model approval is set.</p> + */ + ApprovalDescription?: string; + + /** + * @public + * <p>The machine learning domain of your model package and its components. Common + * machine learning domains include computer vision and natural language processing.</p> + */ + Domain?: string; + + /** + * @public + * <p>The machine learning task your model package accomplishes. Common machine + * learning tasks include object detection and image classification.</p> + */ + Task?: string; + + /** + * @public + * <p>The Amazon Simple Storage Service path where the sample payload are stored. This path must point to + * a single gzip compressed tar archive (.tar.gz suffix).</p> + */ + SamplePayloadUrl?: string; + + /** + * @public + * <p>An array of additional Inference Specification objects.</p> + */ + AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[]; + + /** + * @public + * <p>A list of the tags associated with the model package. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services + * resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p> + */ + Tags?: Tag[]; + + /** + * @public + * <p>The metadata properties for the model package. </p> + */ + CustomerMetadataProperties?: Record<string, string>; + + /** + * @public + * <p>Represents the drift check baselines that can be used when the model monitor is set using the model package.</p> + */ + DriftCheckBaselines?: DriftCheckBaselines; + + /** + * @public + * <p>Indicates if you want to skip model validation.</p> + */ + SkipModelValidation?: SkipModelValidation | string; +} + /** * @public * <p>A group of versioned models in the model registry.</p> diff --git a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts index 18ddc6c2c072..9710657d98c5 100644 --- a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts +++ b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts @@ -798,6 +798,7 @@ import { ActionSummary, AddAssociationRequest, AdditionalInferenceSpecificationDefinition, + AdditionalS3DataSource, AddTagsInput, AggregationTransformationValue, Alarm, @@ -892,12 +893,10 @@ import { CreateCompilationJobRequest, CreateContextRequest, CreateDataQualityJobDefinitionRequest, - CreateDeviceFleetRequest, DataQualityAppSpecification, DataQualityBaselineConfig, DataQualityJobInput, DataSource, - EdgeOutputConfig, EndpointInput, FileSystemConfig, FileSystemDataSource, @@ -981,6 +980,7 @@ import { WorkspaceSettings, } from "../models/models_0"; import { + CreateDeviceFleetRequest, CreateDomainRequest, CreateEdgeDeploymentPlanRequest, CreateEdgeDeploymentStageRequest, @@ -1053,6 +1053,7 @@ import { DriftCheckModelQuality, EdgeDeploymentConfig, EdgeDeploymentModelConfig, + EdgeOutputConfig, EndpointInfo, EndpointInputConfiguration, EnvironmentParameterRanges, @@ -1160,7 +1161,6 @@ import { RecommendationJobVpcConfig, RedshiftDatasetDefinition, ResourceLimits, - RetentionPolicy, RetryStrategy, RollingUpdatePolicy, RSessionAppSettings, @@ -1362,8 +1362,6 @@ import { EnableSagemakerServicecatalogPortfolioInput, Endpoint, EndpointConfigSummary, - EndpointSummary, - Experiment, FeatureParameter, FinalHyperParameterTuningJobObjectiveMetric, HyperParameterTrainingJobSummary, @@ -1379,6 +1377,7 @@ import { ProductionVariantSummary, ProfilerRuleEvaluationStatus, RecommendationMetrics, + RetentionPolicy, RStudioServerProDomainSettingsForUpdate, ScalingPolicy, SecondaryStatusTransition, @@ -1390,6 +1389,8 @@ import { Workteam, } from "../models/models_2"; import { + EndpointSummary, + Experiment, ExperimentSummary, FeatureGroup, FeatureGroupSummary, @@ -1565,12 +1566,10 @@ import { ModelCardSummary, ModelCardVersionSummary, ModelDashboardEndpoint, - ModelDashboardModel, ModelDashboardModelCard, ModelDashboardMonitoringSchedule, ModelMetadataFilter, ModelMetadataSearchExpression, - ModelPackage, ModelPackageGroupSummary, ModelPackageSummary, ModelSummary, @@ -1601,6 +1600,8 @@ import { UserProfileDetails, } from "../models/models_3"; import { + ModelDashboardModel, + ModelPackage, ModelPackageGroup, ModelVariantAction, NestedFilters, @@ -19182,6 +19183,8 @@ const de_ResourceNotFoundRes = async (parsedOutput: any, context: __SerdeContext // se_AdditionalInferenceSpecifications omitted. +// se_AdditionalS3DataSource omitted. + // se_AddTagsInput omitted. // se_AggregationTransformations omitted. @@ -22256,6 +22259,8 @@ const de_ActionSummary = (output: any, context: __SerdeContext): ActionSummary = // de_AdditionalInferenceSpecifications omitted. +// de_AdditionalS3DataSource omitted. + // de_AddTagsOutput omitted. // de_AgentVersion omitted. diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index d82baac5ab08..d3925e772698 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -371,6 +371,45 @@ } } }, + "com.amazonaws.sagemaker#AdditionalS3DataSource": { + "type": "structure", + "members": { + "S3DataType": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType", + "traits": { + "smithy.api#documentation": "<p>The data type of the additional data source that you specify for use in inference or\n training. </p>", + "smithy.api#required": {} + } + }, + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "<p>The uniform resource identifier (URI) used to identify an additional data source used\n in inference or training.</p>", + "smithy.api#required": {} + } + }, + "CompressionType": { + "target": "com.amazonaws.sagemaker#CompressionType", + "traits": { + "smithy.api#documentation": "<p>The type of compression used for an additional data source used in inference or\n training. Specify <code>None</code> if your additional data source is not compressed.</p>" + } + } + }, + "traits": { + "smithy.api#documentation": "<p>A data source used for training or inference that is in addition to the input dataset\n or model data.</p>" + } + }, + "com.amazonaws.sagemaker#AdditionalS3DataSourceDataType": { + "type": "enum", + "members": { + "S3OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3Object" + } + } + } + }, "com.amazonaws.sagemaker#AgentVersion": { "type": "structure", "members": { @@ -4293,7 +4332,7 @@ } }, "traits": { - "smithy.api#documentation": "<p>Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy.\n You can specify your batches as either instance count or the overall percentage or your fleet.</p>\n <p>For a rollback strategy, if you don't specify the fields in this object, or if you set the <code>Value</code> to 100%, then SageMaker\n uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.</p>" + "smithy.api#documentation": "<p>Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.</p>\n <p>For a rollback strategy, if you don't specify the fields in this object, or if you set\n the <code>Value</code> to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.</p>" } }, "com.amazonaws.sagemaker#CapacitySizeType": { @@ -6183,7 +6222,7 @@ "ModelDataSource": { "target": "com.amazonaws.sagemaker#ModelDataSource", "traits": { - "smithy.api#documentation": "<p>Specifies the location of ML model data to deploy.</p>\n <note>\n <p>Currently you cannot use <code>ModelDataSource</code> in conjunction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.</p>\n </note>" + "smithy.api#documentation": "<p>Specifies the location of ML model data to deploy.</p>\n <note>\n <p>Currently you cannot use <code>ModelDataSource</code> in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.</p>\n </note>" } } }, @@ -16053,7 +16092,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "<p>The status of the endpoint.</p>\n <ul>\n <li>\n <p>\n <code>OutOfService</code>: Endpoint is not available to take incoming\n requests.</p>\n </li>\n <li>\n <p>\n <code>Creating</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html\">CreateEndpoint</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>Updating</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html\">UpdateEndpoint</a> or <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.</p>\n </li>\n <li>\n <p>\n <code>RollingBack</code>: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n <code>InService</code> status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> call or when the <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> operation is called\n explicitly.</p>\n </li>\n <li>\n <p>\n <code>InService</code>: Endpoint is available to process incoming\n requests.</p>\n </li>\n <li>\n <p>\n <code>Deleting</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html\">DeleteEndpoint</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use\n the <code>FailureReason</code> value returned by <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html\">DescribeEndpoint</a> for information about the failure. <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html\">DeleteEndpoint</a> is the only operation that can be performed on a\n failed endpoint.</p>\n </li>\n <li>\n <p>\n <code>UpdateRollbackFailed</code>: Both the rolling deployment and auto-rollback failed. Your endpoint\n is in service with a mix of the old and new endpoint configurations. For information about how to remedy\n this issue and restore the endpoint's status to <code>InService</code>, see\n <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html\">Rolling Deployments</a>.</p>\n </li>\n </ul>", + "smithy.api#documentation": "<p>The status of the endpoint.</p>\n <ul>\n <li>\n <p>\n <code>OutOfService</code>: Endpoint is not available to take incoming\n requests.</p>\n </li>\n <li>\n <p>\n <code>Creating</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html\">CreateEndpoint</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>Updating</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html\">UpdateEndpoint</a> or <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>SystemUpdating</code>: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.</p>\n </li>\n <li>\n <p>\n <code>RollingBack</code>: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n <code>InService</code> status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> call or when the <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html\">UpdateEndpointWeightsAndCapacities</a> operation is called\n explicitly.</p>\n </li>\n <li>\n <p>\n <code>InService</code>: Endpoint is available to process incoming\n requests.</p>\n </li>\n <li>\n <p>\n <code>Deleting</code>: <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html\">DeleteEndpoint</a> is executing.</p>\n </li>\n <li>\n <p>\n <code>Failed</code>: Endpoint could not be created, updated, or re-scaled. Use\n the <code>FailureReason</code> value returned by <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html\">DescribeEndpoint</a> for information about the failure. <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html\">DeleteEndpoint</a> is the only operation that can be performed on a\n failed endpoint.</p>\n </li>\n <li>\n <p>\n <code>UpdateRollbackFailed</code>: Both the rolling deployment and\n auto-rollback failed. Your endpoint is in service with a mix of the old and new\n endpoint configurations. For information about how to remedy this issue and\n restore the endpoint's status to <code>InService</code>, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html\">Rolling\n Deployments</a>.</p>\n </li>\n </ul>", "smithy.api#required": {} } }, @@ -26762,7 +26801,7 @@ "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "<p>The number of instances of the type specified by <code>InstanceType</code>. Choose an\n instance count larger than 1 for distributed training algorithms. See <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html\">Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK</a> for more information.</p>", + "smithy.api#documentation": "<p>The number of instances of the type specified by <code>InstanceType</code>. Choose an\n instance count larger than 1 for distributed training algorithms. See <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html\">Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK</a> for more\n information.</p>", "smithy.api#required": {} } }, @@ -38917,7 +38956,7 @@ } }, "traits": { - "smithy.api#documentation": "<p>Specifies the location of ML model data to deploy. If specified, you must specify\n one and only one of the available data sources.</p>" + "smithy.api#documentation": "<p>Specifies the location of ML model data to deploy. If specified, you must specify one\n and only one of the available data sources.</p>" } }, "com.amazonaws.sagemaker#ModelDeployConfig": { @@ -39554,6 +39593,12 @@ "traits": { "smithy.api#documentation": "<p>The name of a pre-trained machine learning benchmarked by \n Amazon SageMaker Inference Recommender model that matches your model. \n You can find a list of benchmarked models by calling <code>ListModelMetadata</code>.</p>" } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "<p>The additional data source that is used during inference in the Docker container for\n your model package.</p>" + } } }, "traits": { @@ -42651,7 +42696,7 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#OutputCompressionType", "traits": { - "smithy.api#documentation": "<p>The model output compression type. Select <code>None</code> to output an uncompressed model, recommended for large model outputs. Defaults to gzip.</p>" + "smithy.api#documentation": "<p>The model output compression type. Select <code>None</code> to output an uncompressed\n model, recommended for large model outputs. Defaults to gzip.</p>" } } }, @@ -48766,7 +48811,7 @@ "WaitIntervalInSeconds": { "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", "traits": { - "smithy.api#documentation": "<p>The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.</p>", + "smithy.api#documentation": "<p>The length of the baking period, during which SageMaker monitors alarms for each batch on\n the new fleet.</p>", "smithy.api#required": {} } }, @@ -48779,7 +48824,7 @@ "RollbackMaximumBatchSize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "<p>Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new\n endpoint fleet. If this field is absent, the default value will be set to 100% of total\n capacity which means to bring up the whole capacity of the old fleet at once during rollback.</p>" + "smithy.api#documentation": "<p>Batch size for rollback to the old endpoint fleet. Each rolling step to provision\n capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the\n new endpoint fleet. If this field is absent, the default value will be set to 100% of\n total capacity which means to bring up the whole capacity of the old fleet at once\n during rollback.</p>" } } }, @@ -48970,7 +49015,7 @@ "CompressionType": { "target": "com.amazonaws.sagemaker#ModelCompressionType", "traits": { - "smithy.api#documentation": "<p>Specifies how the ML model data is prepared.</p>\n <p>If you choose <code>Gzip</code> and choose <code>S3Object</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.</p>\n <p>If you choose <code>None</code> and chooose <code>S3Object</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies an object that represents an\n uncompressed ML model to deploy.</p>\n <p>If you choose None and choose <code>S3Prefix</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.</p>\n <p>If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:</p>\n <ul>\n <li>\n <p>If you choose <code>S3Object</code> as the value of <code>S3DataType</code>,\n then SageMaker will split the key of the S3 object referenced by <code>S3Uri</code> by\n slash (/), and use the last part as the filename of the file holding the content\n of the S3 object.</p>\n </li>\n <li>\n <p>If you choose <code>S3Prefix</code> as the value of <code>S3DataType</code>,\n then for each S3 object under the key name pefix referenced by <code>S3Uri</code>,\n SageMaker will trim its key by the prefix, and use the remainder as the path\n (relative to <code>/opt/ml/model</code>) of the file holding the content of the\n S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as\n directory names and the last part as filename of the file holding the content of\n the S3 object.</p>\n </li>\n <li>\n <p>Do not use any of the following as file names or directory names:</p>\n <ul>\n <li>\n <p>An empty or blank string</p>\n </li>\n <li>\n <p>A string which contains null bytes</p>\n </li>\n <li>\n <p>A string longer than 255 bytes</p>\n </li>\n <li>\n <p>A single dot (<code>.</code>)</p>\n </li>\n <li>\n <p>A double dot (<code>..</code>)</p>\n </li>\n </ul>\n </li>\n <li>\n <p>Ambiguous file names will result in model deployment failure. For example,\n if your uncompressed ML model consists of two S3 objects\n <code>s3://mybucket/model/weights</code> and <code>s3://mybucket/model/weights/part1</code>\n and you specify <code>s3://mybucket/model/</code> as the value of <code>S3Uri</code> and\n <code>S3Prefix</code> as the value of <code>S3DataType</code>, then it will result in name\n clash between <code>/opt/ml/model/weights</code> (a regular file) and\n <code>/opt/ml/model/weights/</code> (a directory).</p>\n </li>\n <li>\n <p>Do not organize the model artifacts in\n <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html\">S3 console using folders</a>.\n When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the\n folder name you provide. They key of the 0-byte object ends with a slash (/) which violates\n SageMaker restrictions on model artifact file names, leading to model deployment failure.\n </p>\n </li>\n </ul>", + "smithy.api#documentation": "<p>Specifies how the ML model data is prepared.</p>\n <p>If you choose <code>Gzip</code> and choose <code>S3Object</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during\n model deployment.</p>\n <p>If you choose <code>None</code> and chooose <code>S3Object</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies an object that represents an\n uncompressed ML model to deploy.</p>\n <p>If you choose None and choose <code>S3Prefix</code> as the value of\n <code>S3DataType</code>, <code>S3Uri</code> identifies a key name prefix, under\n which all objects represents the uncompressed ML model to deploy.</p>\n <p>If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:</p>\n <ul>\n <li>\n <p>If you choose <code>S3Object</code> as the value of <code>S3DataType</code>,\n then SageMaker will split the key of the S3 object referenced by <code>S3Uri</code>\n by slash (/), and use the last part as the filename of the file holding the\n content of the S3 object.</p>\n </li>\n <li>\n <p>If you choose <code>S3Prefix</code> as the value of <code>S3DataType</code>,\n then for each S3 object under the key name pefix referenced by\n <code>S3Uri</code>, SageMaker will trim its key by the prefix, and use the\n remainder as the path (relative to <code>/opt/ml/model</code>) of the file\n holding the content of the S3 object. SageMaker will split the remainder by slash\n (/), using intermediate parts as directory names and the last part as filename\n of the file holding the content of the S3 object.</p>\n </li>\n <li>\n <p>Do not use any of the following as file names or directory names:</p>\n <ul>\n <li>\n <p>An empty or blank string</p>\n </li>\n <li>\n <p>A string which contains null bytes</p>\n </li>\n <li>\n <p>A string longer than 255 bytes</p>\n </li>\n <li>\n <p>A single dot (<code>.</code>)</p>\n </li>\n <li>\n <p>A double dot (<code>..</code>)</p>\n </li>\n </ul>\n </li>\n <li>\n <p>Ambiguous file names will result in model deployment failure. For example, if\n your uncompressed ML model consists of two S3 objects\n <code>s3://mybucket/model/weights</code> and\n <code>s3://mybucket/model/weights/part1</code> and you specify\n <code>s3://mybucket/model/</code> as the value of <code>S3Uri</code> and\n <code>S3Prefix</code> as the value of <code>S3DataType</code>, then it will\n result in name clash between <code>/opt/ml/model/weights</code> (a regular file)\n and <code>/opt/ml/model/weights/</code> (a directory).</p>\n </li>\n <li>\n <p>Do not organize the model artifacts in <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html\">S3 console using\n folders</a>. When you create a folder in S3 console, S3 creates a 0-byte\n object with a key set to the folder name you provide. They key of the 0-byte\n object ends with a slash (/) which violates SageMaker restrictions on model artifact\n file names, leading to model deployment failure. </p>\n </li>\n </ul>", "smithy.api#required": {} } } @@ -51631,7 +51676,7 @@ "SourcePipelineExecutionArn": { "target": "com.amazonaws.sagemaker#PipelineExecutionArn", "traits": { - "smithy.api#documentation": "<p>The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either <code>Failed</code>\n or <code>Success</code>.</p>\n <p>This field is required if the steps you specify for\n <code>SelectedSteps</code> depend on output collaterals from any non-specified pipeline\n steps. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html\">Selective\n Execution for Pipeline Steps</a>.</p>" + "smithy.api#documentation": "<p>The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either <code>Failed</code>\n or <code>Success</code>.</p>" } }, "SelectedSteps": { @@ -55838,6 +55883,12 @@ "traits": { "smithy.api#documentation": "<p>A list of the metrics that the algorithm emits that can be used as the objective\n metric in a hyperparameter tuning job.</p>" } + }, + "AdditionalS3DataSource": { + "target": "com.amazonaws.sagemaker#AdditionalS3DataSource", + "traits": { + "smithy.api#documentation": "<p>The additional data source used during the training job.</p>" + } } }, "traits": {