Creates a model package that you can use to create SageMaker models or list on Amazon Web Services - * Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to - * model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
+ *Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers + * can subscribe to model packages listed on Amazon Web Services Marketplace to create + * models in SageMaker.
*To create a model package by specifying a Docker container that contains your
* inference code and the Amazon S3 location of your model artifacts, provide values for
- * InferenceSpecification. To create a model from an algorithm resource
+ * InferenceSpecification. To create a model from an algorithm resource
* that you created or subscribed to in Amazon Web Services Marketplace, provide a value for
- * SourceAlgorithmSpecification.
SourceAlgorithmSpecification.
* There are two types of model packages:
*Deletes a model package.
- *A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can - * subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
+ *A model package is used to create SageMaker models or list on Amazon Web Services + * Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services + * Marketplace to create models in SageMaker.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts index a0a08a710d72..ed8955916666 100644 --- a/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeInferenceComponentCommand.ts @@ -79,6 +79,27 @@ export interface DescribeInferenceComponentCommandOutput extends DescribeInferen * // CreationTime: new Date("TIMESTAMP"), // required * // LastModifiedTime: new Date("TIMESTAMP"), // required * // InferenceComponentStatus: "InService" || "Creating" || "Updating" || "Failed" || "Deleting", + * // LastDeploymentConfig: { // InferenceComponentDeploymentConfig + * // RollingUpdatePolicy: { // InferenceComponentRollingUpdatePolicy + * // MaximumBatchSize: { // InferenceComponentCapacitySize + * // Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required + * // Value: Number("int"), // required + * // }, + * // WaitIntervalInSeconds: Number("int"), // required + * // MaximumExecutionTimeoutInSeconds: Number("int"), + * // RollbackMaximumBatchSize: { + * // Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required + * // Value: Number("int"), // required + * // }, + * // }, + * // AutoRollbackConfiguration: { // AutoRollbackConfig + * // Alarms: [ // AlarmList + * // { // Alarm + * // AlarmName: "STRING_VALUE", + * // }, + * // ], + * // }, + * // }, * // }; * * ``` diff --git a/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts b/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts index e709ddc10edf..98d80d2a4826 100644 --- a/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts +++ b/clients/client-sagemaker/src/commands/DescribeModelPackageCommand.ts @@ -36,11 +36,10 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO * models or list them on Amazon Web Services Marketplace. *If you provided a KMS Key ID when you created your model package, - * you will see the KMS - * Decrypt API call in your CloudTrail logs when you use this API.
+ * you will see the KMS Decrypt API call in + * your CloudTrail logs when you use this API. *To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services - * Marketplace.
+ *To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-sagemaker/src/commands/GetModelPackageGroupPolicyCommand.ts b/clients/client-sagemaker/src/commands/GetModelPackageGroupPolicyCommand.ts index 4c150eed393b..1b37747367c9 100644 --- a/clients/client-sagemaker/src/commands/GetModelPackageGroupPolicyCommand.ts +++ b/clients/client-sagemaker/src/commands/GetModelPackageGroupPolicyCommand.ts @@ -30,8 +30,8 @@ export interface GetModelPackageGroupPolicyCommandOutput extends GetModelPackage /** *Gets a resource policy that manages access for a model group. For information about * resource policies, see Identity-based - * policies and resource-based policies in the Amazon Web Services Identity and - * Access Management User Guide..
+ * policies and resource-based policies in the Amazon Web Services + * Identity and Access Management User Guide.. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-sagemaker/src/commands/ListDataQualityJobDefinitionsCommand.ts b/clients/client-sagemaker/src/commands/ListDataQualityJobDefinitionsCommand.ts index 01a585c5110c..4f09bbbe951e 100644 --- a/clients/client-sagemaker/src/commands/ListDataQualityJobDefinitionsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListDataQualityJobDefinitionsCommand.ts @@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListDataQualityJobDefinitionsRequest, ListDataQualityJobDefinitionsResponse } from "../models/models_3"; +import { ListDataQualityJobDefinitionsRequest } from "../models/models_3"; +import { ListDataQualityJobDefinitionsResponse } from "../models/models_4"; import { de_ListDataQualityJobDefinitionsCommand, se_ListDataQualityJobDefinitionsCommand, diff --git a/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts b/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts index b3b185bc66bf..93d6481928be 100644 --- a/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts +++ b/clients/client-sagemaker/src/commands/ListDeviceFleetsCommand.ts @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListDeviceFleetsRequest } from "../models/models_3"; -import { ListDeviceFleetsResponse } from "../models/models_4"; +import { ListDeviceFleetsRequest, ListDeviceFleetsResponse } from "../models/models_4"; import { de_ListDeviceFleetsCommand, se_ListDeviceFleetsCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/PutModelPackageGroupPolicyCommand.ts b/clients/client-sagemaker/src/commands/PutModelPackageGroupPolicyCommand.ts index 00fce5417d11..215349573b13 100644 --- a/clients/client-sagemaker/src/commands/PutModelPackageGroupPolicyCommand.ts +++ b/clients/client-sagemaker/src/commands/PutModelPackageGroupPolicyCommand.ts @@ -30,7 +30,8 @@ export interface PutModelPackageGroupPolicyCommandOutput extends PutModelPackage /** *Adds a resouce policy to control access to a model group. For information about * resoure policies, see Identity-based - * policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
+ * policies and resource-based policies in the Amazon Web Services + * Identity and Access Management User Guide.. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-sagemaker/src/commands/StopProcessingJobCommand.ts b/clients/client-sagemaker/src/commands/StopProcessingJobCommand.ts index f1cd30fb6770..5bc631beac44 100644 --- a/clients/client-sagemaker/src/commands/StopProcessingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/StopProcessingJobCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StopProcessingJobRequest } from "../models/models_4"; +import { StopProcessingJobRequest } from "../models/models_5"; import { de_StopProcessingJobCommand, se_StopProcessingJobCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/StopTrainingJobCommand.ts b/clients/client-sagemaker/src/commands/StopTrainingJobCommand.ts index 962daf101438..a80cca6621b8 100644 --- a/clients/client-sagemaker/src/commands/StopTrainingJobCommand.ts +++ b/clients/client-sagemaker/src/commands/StopTrainingJobCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StopTrainingJobRequest } from "../models/models_4"; +import { StopTrainingJobRequest } from "../models/models_5"; import { de_StopTrainingJobCommand, se_StopTrainingJobCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/StopTransformJobCommand.ts b/clients/client-sagemaker/src/commands/StopTransformJobCommand.ts index 0ed66faf312e..f722f0043c41 100644 --- a/clients/client-sagemaker/src/commands/StopTransformJobCommand.ts +++ b/clients/client-sagemaker/src/commands/StopTransformJobCommand.ts @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StopTransformJobRequest } from "../models/models_4"; +import { StopTransformJobRequest } from "../models/models_5"; import { de_StopTransformJobCommand, se_StopTransformJobCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateActionCommand.ts b/clients/client-sagemaker/src/commands/UpdateActionCommand.ts index a73d4e498633..7c63b80955ec 100644 --- a/clients/client-sagemaker/src/commands/UpdateActionCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateActionCommand.ts @@ -5,8 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { commonParams } from "../endpoint/EndpointParameters"; -import { UpdateActionRequest } from "../models/models_4"; -import { UpdateActionResponse } from "../models/models_5"; +import { UpdateActionRequest, UpdateActionResponse } from "../models/models_5"; import { de_UpdateActionCommand, se_UpdateActionCommand } from "../protocols/Aws_json1_1"; import { SageMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SageMakerClient"; diff --git a/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts b/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts index befcd71c16fe..6ccfb00b4503 100644 --- a/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts +++ b/clients/client-sagemaker/src/commands/UpdateInferenceComponentCommand.ts @@ -61,6 +61,27 @@ export interface UpdateInferenceComponentCommandOutput extends UpdateInferenceCo * RuntimeConfig: { // InferenceComponentRuntimeConfig * CopyCount: Number("int"), // required * }, + * DeploymentConfig: { // InferenceComponentDeploymentConfig + * RollingUpdatePolicy: { // InferenceComponentRollingUpdatePolicy + * MaximumBatchSize: { // InferenceComponentCapacitySize + * Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required + * Value: Number("int"), // required + * }, + * WaitIntervalInSeconds: Number("int"), // required + * MaximumExecutionTimeoutInSeconds: Number("int"), + * RollbackMaximumBatchSize: { + * Type: "COPY_COUNT" || "CAPACITY_PERCENT", // required + * Value: Number("int"), // required + * }, + * }, + * AutoRollbackConfiguration: { // AutoRollbackConfig + * Alarms: [ // AlarmList + * { // Alarm + * AlarmName: "STRING_VALUE", + * }, + * ], + * }, + * }, * }; * const command = new UpdateInferenceComponentCommand(input); * const response = await client.send(command); diff --git a/clients/client-sagemaker/src/models/models_0.ts b/clients/client-sagemaker/src/models/models_0.ts index 66ac8dc602b7..b6ad77503cd8 100644 --- a/clients/client-sagemaker/src/models/models_0.ts +++ b/clients/client-sagemaker/src/models/models_0.ts @@ -533,7 +533,7 @@ export interface ModelPackageContainerDefinition { *The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
*If you are using your own custom algorithm instead of an algorithm provided by SageMaker,
* the inference code must meet SageMaker requirements. SageMaker supports both
- * registry/repository[:tag] and registry/repository[@digest]
+ * registry/repository[:tag] and registry/repository[@digest]
* image path formats. For more information, see Using Your Own Algorithms with Amazon
* SageMaker.
The Amazon S3 path where the model artifacts, which result from model training, are stored.
* This path must point to a single gzip compressed tar archive
- * (.tar.gz suffix).
.tar.gz suffix).
* The model artifacts must be in an S3 bucket that is in the same region as the * model package.
@@ -573,7 +573,7 @@ export interface ModelPackageContainerDefinition { /** *The environment variables to set in the Docker container. Each key and value in the
- * Environment string to string map can have length of up to 1024. We
+ * Environment string to string map can have length of up to 1024. We
* support up to 16 entries in the map.
A list of node IDs to be deleted from the specified cluster.
*For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances - * that are configured as Slurm controller nodes.
+ *For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove + * instances that are configured as Slurm controller nodes.
+ *If you need to delete more than 99 instances, contact Support for assistance.
+ *A map of the resource and BatchDescribeModelPackageError objects - * reporting the error associated with describing the model package.
+ *A map of the resource and BatchDescribeModelPackageError objects reporting the error + * associated with describing the model package.
* @public */ BatchDescribeModelPackageErrorMap?: RecordDefines the traffic routing strategy during an endpoint deployment to shift traffic from the - * old fleet to the new fleet.
+ *Defines the traffic routing strategy during an endpoint deployment to shift traffic + * from the old fleet to the new fleet.
* @public */ export interface TrafficRoutingConfig { @@ -8334,22 +8341,19 @@ export interface TrafficRoutingConfig { *
- * ALL_AT_ONCE: Endpoint traffic shifts to the new fleet
- * in a single step.
- *
ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single
+ * step.
*
- * CANARY: Endpoint traffic shifts to the new fleet
- * in two steps. The first step is the canary, which is a small portion of the traffic. The
- * second step is the remainder of the traffic.
- *
CANARY: Endpoint traffic shifts to the new fleet in two steps.
+ * The first step is the canary, which is a small portion of the traffic. The
+ * second step is the remainder of the traffic.
*
- * LINEAR: Endpoint traffic shifts to the new fleet in
- * n steps of a configurable size.
- *
LINEAR: Endpoint traffic shifts to the new fleet in n steps of a
+ * configurable size.
* The waiting time (in seconds) between incremental steps to turn on traffic on the - * new endpoint fleet.
+ *The waiting time (in seconds) between incremental steps to turn on traffic on the new + * endpoint fleet.
* @public */ WaitIntervalInSeconds: number | undefined; /** - *Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than
- * or equal to 50% of the variant's total instance count.
Batch size for the first step to turn on traffic on the new endpoint fleet.
+ * Value must be less than or equal to 50% of the variant's total instance
+ * count.
Batch size for each step to turn on traffic on the new endpoint fleet. Value must be
- * 10-50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet.
+ * Value must be 10-50% of the variant's total instance count.
The container for the metadata for the ClarifyCheck step. For more information, - * see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide. - *
+ *The container for the metadata for the ClarifyCheck step. For more information, see + * the topic on ClarifyCheck step in the Amazon SageMaker Developer + * Guide.
* @public */ export interface ClarifyCheckStepMetadata { @@ -8944,23 +8949,27 @@ export interface ClarifyCheckStepMetadata { ViolationReport?: string | undefined; /** - *The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
+ *The Amazon Resource Name (ARN) of the check processing job that was run by this step's + * execution.
* @public */ CheckJobArn?: string | undefined; /** - *This flag indicates if the drift check against the previous baseline will be skipped or not.
- * If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped
+ * or not. If it is set to False, the previous baseline of the configured
+ * check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties
- * BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics.
- * If it is set to False, the previous baseline of the configured check type must also be available.
- * These can be accessed through the BaselineUsedForDriftCheckConstraints property.
This flag indicates if a newly calculated baseline can be accessed through step
+ * properties BaselineUsedForDriftCheckConstraints and
+ * BaselineUsedForDriftCheckStatistics. If it is set to
+ * False, the previous baseline of the configured check type must also be
+ * available. These can be accessed through the
+ * BaselineUsedForDriftCheckConstraints property.
Represents the drift check bias baselines that can be used when the model monitor is set using the - * model package.
+ *Represents the drift check bias baselines that can be used when the model monitor is + * set using the model package.
* @public */ export interface DriftCheckBias { @@ -11904,8 +11904,8 @@ export interface DriftCheckBias { } /** - *Represents the drift check explainability baselines that can be used when the model monitor is set - * using the model package.
+ *Represents the drift check explainability baselines that can be used when the model + * monitor is set using the model package.
* @public */ export interface DriftCheckExplainability { @@ -11923,8 +11923,8 @@ export interface DriftCheckExplainability { } /** - *Represents the drift check data quality baselines that can be used when the model monitor is set using - * the model package.
+ *Represents the drift check data quality baselines that can be used when the model + * monitor is set using the model package.
* @public */ export interface DriftCheckModelDataQuality { @@ -11942,8 +11942,8 @@ export interface DriftCheckModelDataQuality { } /** - *Represents the drift check model quality baselines that can be used when the model monitor is set using - * the model package.
+ *Represents the drift check model quality baselines that can be used when the model + * monitor is set using the model package.
* @public */ export interface DriftCheckModelQuality { @@ -11961,64 +11961,64 @@ export interface DriftCheckModelQuality { } /** - *Represents the drift check baselines that can be used when the model monitor is set using the model - * package.
+ *Represents the drift check baselines that can be used when the model monitor is set + * using the model package.
* @public */ export interface DriftCheckBaselines { /** - *Represents the drift check bias baselines that can be used when the model monitor is set using the model - * package.
+ *Represents the drift check bias baselines that can be used when the model monitor is + * set using the model package.
* @public */ Bias?: DriftCheckBias | undefined; /** - *Represents the drift check explainability baselines that can be used when the model monitor is set using - * the model package.
+ *Represents the drift check explainability baselines that can be used when the model + * monitor is set using the model package.
* @public */ Explainability?: DriftCheckExplainability | undefined; /** - *Represents the drift check model quality baselines that can be used when the model monitor is set using - * the model package.
+ *Represents the drift check model quality baselines that can be used when the model + * monitor is set using the model package.
* @public */ ModelQuality?: DriftCheckModelQuality | undefined; /** - *Represents the drift check model data quality baselines that can be used when the model monitor is set - * using the model package.
+ *Represents the drift check model data quality baselines that can be used when the + * model monitor is set using the model package.
* @public */ ModelDataQuality?: DriftCheckModelDataQuality | undefined; } /** - *The model card associated with the model package. Since ModelPackageModelCard is
- * tied to a model package, it is a specific usage of a model card and its schema is
- * simplified compared to the schema of ModelCard. The
- * ModelPackageModelCard schema does not include model_package_details,
- * and model_overview is composed of the model_creator and
- * model_artifact properties. For more information about the model package model
- * card schema, see Model
- * package model card schema. For more information about
- * the model card associated with the model package, see View
- * the Details of a Model Version.
The model card associated with the model package. Since
+ * ModelPackageModelCard is tied to a model package, it is a specific
+ * usage of a model card and its schema is simplified compared to the schema of
+ * ModelCard. The ModelPackageModelCard schema does not
+ * include model_package_details, and model_overview is composed
+ * of the model_creator and model_artifact properties. For more
+ * information about the model package model card schema, see Model
+ * package model card schema. For more information about the model card
+ * associated with the model package, see View the Details of a Model
+ * Version.
The content of the model card. The content must follow the schema described - * in Model - * Package Model Card Schema.
+ *The content of the model card. The content must follow the schema described in Model + * Package Model Card Schema.
* @public */ ModelCardContent?: string | undefined; /** - *The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
+ *The approval status of the model card within your organization. Different + * organizations might have different criteria for model card review and approval.
*@@ -12034,9 +12034,9 @@ export interface ModelPackageModelCard { *
- * Archived: The model card is archived. No more updates can be made to the model
- * card content. If you try to update the model card content, you will receive the message Model Card
- * is in Archived state.
Archived: The model card is archived. No more updates can be made
+ * to the model card content. If you try to update the model card content, you will
+ * receive the message Model Card is in Archived state.
* - * A structure describing the current state of the model in its life cycle. - *
+ *A structure describing the current state of the model in its life cycle.
* @public */ export interface ModelLifeCycle { /** - *- * The current stage in the model life cycle. - *
+ *The current stage in the model life cycle.
* @public */ Stage: string | undefined; /** - *- * The current status of a stage in model life cycle. - *
+ *The current status of a stage in model life cycle.
* @public */ StageStatus: string | undefined; /** - *- * Describes the stage related details. - *
+ *Describes the stage related details.
* @public */ StageDescription?: string | undefined; @@ -12155,14 +12147,14 @@ export interface ModelMetrics { } /** - *An optional Key Management Service - * key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with - * highly sensitive data.
+ *An optional Key Management Service key to encrypt, decrypt, and re-encrypt model + * package information for regulated workloads with highly sensitive data.
* @public */ export interface ModelPackageSecurityConfig { /** - *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model
+ * package information.
Contains data, such as the inputs and targeted instance types that are used in the * process of validating the model package.
- *The data provided in the validation profile is made available to your buyers on Amazon Web Services - * Marketplace.
+ *The data provided in the validation profile is made available to your buyers on + * Amazon Web Services Marketplace.
* @public */ export interface ModelPackageValidationProfile { @@ -12287,7 +12279,8 @@ export interface CreateModelPackageInput { ModelPackageName?: string | undefined; /** - *The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
+ *The name or Amazon Resource Name (ARN) of the model package group that this model version belongs + * to.
*This parameter is required for versioned models, and does not apply to unversioned * models.
* @public @@ -12301,8 +12294,8 @@ export interface CreateModelPackageInput { ModelPackageDescription?: string | undefined; /** - *Specifies details about inference jobs that you can run with models based on this model - * package, including the following information:
+ *Specifies details about inference jobs that you can run with models based on this + * model package, including the following information:
*The Amazon ECR paths of containers that contain the inference code and model @@ -12335,7 +12328,8 @@ export interface CreateModelPackageInput { SourceAlgorithmSpecification?: SourceAlgorithmSpecification | undefined; /** - *
Whether to certify the model package for listing on Amazon Web Services Marketplace.
+ *Whether to certify the model package for listing on Amazon Web Services + * Marketplace.
*This parameter is optional for unversioned models, and does not apply to versioned * models.
* @public @@ -12343,12 +12337,11 @@ export interface CreateModelPackageInput { CertifyForMarketplace?: boolean | undefined; /** - *A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.
- *If you supply ModelPackageGroupName, your model package belongs to the model group
- * you specify and uses the tags associated with the model group. In this case, you cannot
- * supply a tag argument.
- *
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide.
+ *If you supply ModelPackageGroupName, your model package belongs to the
+ * model group you specify and uses the tags associated with the model group. In this case,
+ * you cannot supply a tag argument.
This parameter is optional for versioned models, and does not apply to unversioned * models.
*For versioned models, the value of this parameter must be set to Approved
- * to deploy the model.
The machine learning domain of your model package and its components. Common - * machine learning domains include computer vision and natural language processing.
+ *The machine learning domain of your model package and its components. Common machine + * learning domains include computer vision and natural language processing.
* @public */ Domain?: string | undefined; /** - *The machine learning task your model package accomplishes. Common machine
- * learning tasks include object detection and image classification. The following
- * tasks are supported by Inference Recommender:
- * "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" |
- * "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".
The machine learning task your model package accomplishes. Common machine learning
+ * tasks include object detection and image classification. The following tasks are
+ * supported by Inference Recommender: "IMAGE_CLASSIFICATION" |
+ * "OBJECT_DETECTION" | "TEXT_GENERATION"
+ * |"IMAGE_SEGMENTATION" | "FILL_MASK" |
+ * "CLASSIFICATION" | "REGRESSION" |
+ * "OTHER".
Specify "OTHER" if none of the tasks listed fit your use case.
* @public */ Task?: string | undefined; /** - *The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point - * to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files - * that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the - * InvokeEndpoint call.
+ *The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a + * single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple + * files that are all equally used in the load test. Each file in the archive must satisfy + * the size constraints of the InvokeEndpoint call.
* @public */ SamplePayloadUrl?: string | undefined; @@ -12415,18 +12410,18 @@ export interface CreateModelPackageInput { CustomerMetadataProperties?: RecordRepresents the drift check baselines that can be used when the model monitor is set using the model package. - * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. - *
+ *Represents the drift check baselines that can be used when the model monitor is set + * using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker + * Pipelines in the Amazon SageMaker Developer Guide.
* @public */ DriftCheckBaselines?: DriftCheckBaselines | undefined; /** - *An array of additional Inference Specification objects. Each additional - * Inference Specification specifies artifacts based on this model package that can - * be used on inference endpoints. Generally used with SageMaker Neo to store the - * compiled artifacts.
+ *An array of additional Inference Specification objects. Each additional Inference + * Specification specifies artifacts based on this model package that can be used on + * inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. + *
* @public */ AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; @@ -12438,38 +12433,37 @@ export interface CreateModelPackageInput { SkipModelValidation?: SkipModelValidation | undefined; /** - *The URI of the source for the model package. If you want to clone a model package, - * set it to the model package Amazon Resource Name (ARN). If you want to register a model, - * set it to the model ARN.
+ *The URI of the source for the model package. If you want to clone a model package, set + * it to the model package Amazon Resource Name (ARN). If you want to register a model, set + * it to the model ARN.
* @public */ SourceUri?: string | undefined; /** - *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model
+ * package information.
The model card associated with the model package. Since ModelPackageModelCard is
- * tied to a model package, it is a specific usage of a model card and its schema is
- * simplified compared to the schema of ModelCard. The
- * ModelPackageModelCard schema does not include model_package_details,
- * and model_overview is composed of the model_creator and
- * model_artifact properties. For more information about the model package model
- * card schema, see Model
- * package model card schema. For more information about
- * the model card associated with the model package, see View
- * the Details of a Model Version.
The model card associated with the model package. Since
+ * ModelPackageModelCard is tied to a model package, it is a specific
+ * usage of a model card and its schema is simplified compared to the schema of
+ * ModelCard. The ModelPackageModelCard schema does not
+ * include model_package_details, and model_overview is composed
+ * of the model_creator and model_artifact properties. For more
+ * information about the model package model card schema, see Model
+ * package model card schema. For more information about the model card
+ * associated with the model package, see View the Details of a Model
+ * Version.
- * A structure describing the current state of the model in its life cycle. - *
+ *A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; @@ -12504,8 +12498,8 @@ export interface CreateModelPackageGroupInput { /** *A list of key value pairs associated with the model group. For more information, see - * Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.
+ * Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide. * @public */ Tags?: Tag[] | undefined; diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 4448ca3a78d2..6e32b82c60ed 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -4609,8 +4609,8 @@ export interface DeleteModelExplainabilityJobDefinitionRequest { export interface DeleteModelPackageInput { /** *The name or Amazon Resource Name (ARN) of the model package to delete.
- *When you specify a name, the name must have 1 to 63 characters. Valid - * characters are a-z, A-Z, 0-9, and - (hyphen).
+ *When you specify a name, the name must have 1 to 63 characters. Valid characters are + * a-z, A-Z, 0-9, and - (hyphen).
* @public */ ModelPackageName: string | undefined; diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index db980ca3887a..6316642e71ba 100644 --- a/clients/client-sagemaker/src/models/models_3.ts +++ b/clients/client-sagemaker/src/models/models_3.ts @@ -22,6 +22,7 @@ import { AutoMLJobSummary, AutoMLSortBy, AutoMLSortOrder, + AutoRollbackConfig, Autotune, BatchDataCaptureConfig, BatchStrategy, @@ -984,6 +985,122 @@ export const InferenceComponentStatus = { */ export type InferenceComponentStatus = (typeof InferenceComponentStatus)[keyof typeof InferenceComponentStatus]; +/** + * @public + * @enum + */ +export const InferenceComponentCapacitySizeType = { + CAPACITY_PERCENT: "CAPACITY_PERCENT", + COPY_COUNT: "COPY_COUNT", +} as const; + +/** + * @public + */ +export type InferenceComponentCapacitySizeType = + (typeof InferenceComponentCapacitySizeType)[keyof typeof InferenceComponentCapacitySizeType]; + +/** + *Specifies the type and size of the endpoint capacity to activate for a rolling + * deployment or a rollback strategy. You can specify your batches as either of the + * following:
+ *A count of inference component copies
+ *The overall percentage or your fleet
+ *For a rollback strategy, if you don't specify the fields in this object, or if you set
+ * the Value parameter to 100%, then SageMaker AI uses a blue/green rollback
+ * strategy and rolls all traffic back to the blue fleet.
Specifies the endpoint capacity type.
+ *The endpoint activates based on the number of inference component + * copies.
+ *The endpoint activates based on the specified percentage of capacity.
+ *Defines the capacity size, either as a number of inference component copies or a + * capacity percentage.
+ * @public + */ + Value: number | undefined; +} + +/** + *Specifies a rolling deployment strategy for updating a SageMaker AI inference + * component.
+ * @public + */ +export interface InferenceComponentRollingUpdatePolicy { + /** + *The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet, + * and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of + * the copy count of the inference component.
+ * @public + */ + MaximumBatchSize: InferenceComponentCapacitySize | undefined; + + /** + *The length of the baking period, during which SageMaker AI monitors alarms for each + * batch on the new fleet.
+ * @public + */ + WaitIntervalInSeconds: number | undefined; + + /** + *The time limit for the total deployment. Exceeding this limit causes a timeout.
+ * @public + */ + MaximumExecutionTimeoutInSeconds?: number | undefined; + + /** + *The batch size for a rollback to the old endpoint fleet. If this field is absent, the + * value is set to the default, which is 100% of the total capacity. When the default is used, + * SageMaker AI provisions the entire capacity of the old fleet at once during + * rollback.
+ * @public + */ + RollbackMaximumBatchSize?: InferenceComponentCapacitySize | undefined; +} + +/** + *The deployment configuration for an endpoint that hosts inference components. The + * configuration includes the desired deployment strategy and rollback settings.
+ * @public + */ +export interface InferenceComponentDeploymentConfig { + /** + *Specifies a rolling deployment strategy for updating a SageMaker AI + * endpoint.
+ * @public + */ + RollingUpdatePolicy: InferenceComponentRollingUpdatePolicy | undefined; + + /** + *Automatic rollback configuration for handling endpoint deployment failures and + * recovery.
+ * @public + */ + AutoRollbackConfiguration?: AutoRollbackConfig | undefined; +} + /** *Details about the runtime settings for the model that is deployed with the inference * component.
@@ -1143,6 +1260,13 @@ export interface DescribeInferenceComponentOutput { * @public */ InferenceComponentStatus?: InferenceComponentStatus | undefined; + + /** + *The deployment and rollback settings that you assigned to the inference + * component.
+ * @public + */ + LastDeploymentConfig?: InferenceComponentDeploymentConfig | undefined; } /** @@ -2806,8 +2930,8 @@ export interface DescribeModelExplainabilityJobDefinitionResponse { export interface DescribeModelPackageInput { /** *The name or Amazon Resource Name (ARN) of the model package to describe.
- *When you specify a name, the name must have 1 to 63 characters. Valid - * characters are a-z, A-Z, 0-9, and - (hyphen).
+ *When you specify a name, the name must have 1 to 63 characters. Valid characters are + * a-z, A-Z, 0-9, and - (hyphen).
* @public */ ModelPackageName: string | undefined; @@ -2945,7 +3069,8 @@ export interface DescribeModelPackageOutput { ModelPackageStatusDetails: ModelPackageStatusDetails | undefined; /** - *Whether the model package is certified for listing on Amazon Web Services Marketplace.
+ *Whether the model package is certified for listing on Amazon Web Services + * Marketplace.
* @public */ CertifyForMarketplace?: boolean | undefined; @@ -3002,15 +3127,15 @@ export interface DescribeModelPackageOutput { Domain?: string | undefined; /** - *The machine learning task you specified that your model package accomplishes. - * Common machine learning tasks include object detection and image classification.
+ *The machine learning task you specified that your model package accomplishes. Common + * machine learning tasks include object detection and image classification.
* @public */ Task?: string | undefined; /** - *The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single - * gzip compressed tar archive (.tar.gz suffix).
+ *The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a + * single gzip compressed tar archive (.tar.gz suffix).
* @public */ SamplePayloadUrl?: string | undefined; @@ -3022,17 +3147,18 @@ export interface DescribeModelPackageOutput { CustomerMetadataProperties?: RecordRepresents the drift check baselines that can be used when the model monitor is set using the model package. - * For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide. - *
+ *Represents the drift check baselines that can be used when the model monitor is set + * using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker + * Pipelines in the Amazon SageMaker Developer Guide.
* @public */ DriftCheckBaselines?: DriftCheckBaselines | undefined; /** - *An array of additional Inference Specification objects. Each additional - * Inference Specification specifies artifacts based on this model package that can - * be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
+ *An array of additional Inference Specification objects. Each additional Inference + * Specification specifies artifacts based on this model package that can be used on + * inference endpoints. Generally used with SageMaker Neo to store the compiled + * artifacts.
* @public */ AdditionalInferenceSpecifications?: AdditionalInferenceSpecificationDefinition[] | undefined; @@ -3050,30 +3176,29 @@ export interface DescribeModelPackageOutput { SourceUri?: string | undefined; /** - *The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model
+ * package information.
The model card associated with the model package. Since ModelPackageModelCard is
- * tied to a model package, it is a specific usage of a model card and its schema is
- * simplified compared to the schema of ModelCard. The
- * ModelPackageModelCard schema does not include model_package_details,
- * and model_overview is composed of the model_creator and
- * model_artifact properties. For more information about the model package model
- * card schema, see Model
- * package model card schema. For more information about
- * the model card associated with the model package, see View
- * the Details of a Model Version.
The model card associated with the model package. Since
+ * ModelPackageModelCard is tied to a model package, it is a specific
+ * usage of a model card and its schema is simplified compared to the schema of
+ * ModelCard. The ModelPackageModelCard schema does not
+ * include model_package_details, and model_overview is composed
+ * of the model_creator and model_artifact properties. For more
+ * information about the model package model card schema, see Model
+ * package model card schema. For more information about the model card
+ * associated with the model package, see View the Details of a Model
+ * Version.
- * A structure describing the current state of the model in its life cycle. - *
+ *A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; @@ -7759,8 +7884,7 @@ export interface EnableSagemakerServicecatalogPortfolioInput {} export interface EnableSagemakerServicecatalogPortfolioOutput {} /** - *A schedule for a model monitoring job. For information about model monitor, see
- * Amazon SageMaker Model
+ * A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model
* Monitor. A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services
- * resources in the Amazon Web Services General Reference Guide. A list of the tags associated with the monitoring schedlue. For more information, see
+ * Tagging Amazon Web Services resources in the Amazon Web Services General
+ * Reference Guide. The properties of an experiment as returned by the Search API. The properties of an experiment as returned by the Search API.
+ * For information about experiments, see the
+ * CreateExperiment API. Summary information about a monitoring job. The name of the monitoring job. The Amazon Resource Name (ARN) of the monitoring job. The time that the monitoring job was created. The name of the endpoint that the job monitors. A list of data quality monitoring job definitions. If the result of the previous The response from the last list when returning a list large enough to need tokening. The maximum number of results to select. Filter fleets where packaging job was created after specified time. Filter fleets where the edge packaging job was created before specified time. Select fleets where the job was updated after X Select fleets where the job was updated before X Filter for fleets containing this name in their fleet device name. The column to sort by. What direction to sort in. Summary information about a monitoring job. The name of the monitoring job. The Amazon Resource Name (ARN) of the monitoring job. The time that the monitoring job was created. The name of the endpoint that the job monitors. A list of data quality monitoring job definitions. If the result of the previous The response from the last list when returning a list large enough to need tokening. The maximum number of results to select. Filter fleets where packaging job was created after specified time. Filter fleets where the edge packaging job was created before specified time. Select fleets where the job was updated after X Select fleets where the job was updated before X Filter for fleets containing this name in their fleet device name. The column to sort by. What direction to sort in. A filter that returns either model groups shared with you or model groups in
- * your own account. When the value is A filter that returns either model groups shared with you or model groups in your own
+ * account. When the value is If the response is truncated, SageMaker returns this token. To retrieve the next set
- * of model groups, use it in the subsequent request. If the response is truncated, SageMaker returns this token. To retrieve the next set of
+ * model groups, use it in the subsequent request. A filter that returns only model versions that belong to the specified model group. A filter that returns only model versions that belong to the specified model
+ * group.
- * ListDataQualityJobDefinitions request was
- * truncated, the response includes a NextToken. To retrieve the next set of data
- * quality monitoring job definitions, use the token in the next request.ListDataQualityJobDefinitions request was
+ * truncated, the response includes a NextToken. To retrieve the next set of data
+ * quality monitoring job definitions, use the token in the next request.CrossAccount, the results show
- * the resources made discoverable to you from other accounts. When the value is
- * SameAccount or null, the results show resources from your
- * account. The default is SameAccount.CrossAccount, the results show the resources
+ * made discoverable to you from other accounts. When the value is SameAccount
+ * or null, the results show resources from your account. The default is
+ * SameAccount.
*
UNVERSIONED - List only unversioined models.
- * This is the default value if no ModelPackageType is specified.UNVERSIONED - List only unversioined models. This is the default
+ * value if no ModelPackageType is specified.
@@ -8218,12 +8340,35 @@ export interface ModelDashboardModel { } /** - *
A versioned model that can be deployed for SageMaker inference.
+ *A container for your trained model that can be deployed for SageMaker inference. This can + * include inference code, artifacts, and metadata. The model package type can be one of + * the following.
+ *Versioned model: A part of a model package group in Model Registry.
+ *Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.
+ *For more information, see
+ * CreateModelPackage
+ * .
The name of the model.
+ *The name of the model package. The name can be as follows:
+ *For a versioned model, the name is automatically generated by SageMaker Model Registry and
+ * follows the format
+ * 'ModelPackageGroupName/ModelPackageVersion'.
For an unversioned model, you must provide the name.
+ *Specifies batch transform jobs that SageMaker runs to validate your model package.
+ *Specifies batch transform jobs that SageMaker runs to validate your model + * package.
* @public */ ValidationSpecification?: ModelPackageValidationSpecification | undefined; @@ -8298,7 +8444,8 @@ export interface ModelPackage { *
- * DELETING - The model package is in the process of being deleted.
DELETING - The model package is in the process of being
+ * deleted.
* 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 List Your - * Algorithm or Model Package on Amazon Web Services Marketplace.
+ *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 List Your Algorithm or Model + * Package on Amazon Web Services Marketplace.
* @public */ CertifyForMarketplace?: boolean | undefined; @@ -8341,7 +8489,8 @@ export interface ModelPackage { ModelApprovalStatus?: ModelApprovalStatus | undefined; /** - *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, or project.
* @public */ CreatedBy?: UserContext | undefined; @@ -8365,7 +8514,8 @@ export interface ModelPackage { LastModifiedTime?: Date | undefined; /** - *Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
+ *Information about the user who created or modified an experiment, trial, trial + * component, lineage group, or project.
* @public */ LastModifiedBy?: UserContext | undefined; @@ -8377,22 +8527,22 @@ export interface ModelPackage { ApprovalDescription?: string | undefined; /** - *The machine learning domain of your model package and its components. Common - * machine learning domains include computer vision and natural language processing.
+ *The machine learning domain of your model package and its components. Common machine + * learning domains include computer vision and natural language processing.
* @public */ Domain?: string | undefined; /** - *The machine learning task your model package accomplishes. Common machine - * learning tasks include object detection and image classification.
+ *The machine learning task your model package accomplishes. Common machine learning + * tasks include object detection and image classification.
* @public */ Task?: string | undefined; /** - *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).
+ *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).
* @public */ SamplePayloadUrl?: string | undefined; @@ -8410,39 +8560,36 @@ export interface ModelPackage { SourceUri?: string | undefined; /** - *An optional Key Management Service - * key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with - * highly sensitive data.
+ *An optional Key Management Service key to encrypt, decrypt, and re-encrypt model + * package information for regulated workloads with highly sensitive data.
* @public */ SecurityConfig?: ModelPackageSecurityConfig | undefined; /** - *The model card associated with the model package. Since ModelPackageModelCard is
- * tied to a model package, it is a specific usage of a model card and its schema is
- * simplified compared to the schema of ModelCard. The
- * ModelPackageModelCard schema does not include model_package_details,
- * and model_overview is composed of the model_creator and
- * model_artifact properties. For more information about the model package model
- * card schema, see Model
- * package model card schema. For more information about
- * the model card associated with the model package, see View
- * the Details of a Model Version.
The model card associated with the model package. Since
+ * ModelPackageModelCard is tied to a model package, it is a specific
+ * usage of a model card and its schema is simplified compared to the schema of
+ * ModelCard. The ModelPackageModelCard schema does not
+ * include model_package_details, and model_overview is composed
+ * of the model_creator and model_artifact properties. For more
+ * information about the model package model card schema, see Model
+ * package model card schema. For more information about the model card
+ * associated with the model package, see View the Details of a Model
+ * Version.
- * A structure describing the current state of the model in its life cycle. - *
+ *A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; /** - *A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.
+ *A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide.
* @public */ Tags?: Tag[] | undefined; @@ -8454,7 +8601,8 @@ export interface ModelPackage { CustomerMetadataProperties?: RecordRepresents the drift check baselines that can be used when the model monitor is set using the model package.
+ *Represents the drift check baselines that can be used when the model monitor is set + * using the model package.
* @public */ DriftCheckBaselines?: DriftCheckBaselines | undefined; @@ -8467,7 +8615,7 @@ export interface ModelPackage { } /** - *A group of versioned models in the model registry.
+ *A group of versioned models in the Model Registry.
* @public */ export interface ModelPackageGroup { @@ -8524,7 +8672,8 @@ export interface ModelPackageGroup { * *
- * DELETING - The model group is in the process of being deleted.
DELETING - The model group is in the process of being
+ * deleted.
* @@ -8536,8 +8685,8 @@ export interface ModelPackageGroup { ModelPackageGroupStatus?: ModelPackageGroupStatus | undefined; /** - *
A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services - * resources in the Amazon Web Services General Reference Guide.
+ *A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General + * Reference Guide.
* @public */ Tags?: Tag[] | undefined; @@ -10289,13 +10438,26 @@ export interface SearchRecord { Endpoint?: Endpoint | undefined; /** - *A versioned model that can be deployed for SageMaker inference.
+ *A container for your trained model that can be deployed for SageMaker inference. This can + * include inference code, artifacts, and metadata. The model package type can be one of + * the following.
+ *Versioned model: A part of a model package group in Model Registry.
+ *Unversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.
+ *For more information, see
+ * CreateModelPackage
+ * .
A group of versioned models in the model registry.
+ *A group of versioned models in the Model Registry.
* @public */ ModelPackageGroup?: ModelPackageGroup | undefined; @@ -10982,74 +11144,6 @@ export interface StopPipelineExecutionResponse { PipelineExecutionArn?: string | undefined; } -/** - * @public - */ -export interface StopProcessingJobRequest { - /** - *The name of the processing job to stop.
- * @public - */ - ProcessingJobName: string | undefined; -} - -/** - * @public - */ -export interface StopTrainingJobRequest { - /** - *The name of the training job to stop.
- * @public - */ - TrainingJobName: string | undefined; -} - -/** - * @public - */ -export interface StopTransformJobRequest { - /** - *The name of the batch transform job to stop.
- * @public - */ - TransformJobName: string | undefined; -} - -/** - * @public - */ -export interface UpdateActionRequest { - /** - *The name of the action to update.
- * @public - */ - ActionName: string | undefined; - - /** - *The new description for the action.
- * @public - */ - Description?: string | undefined; - - /** - *The new status for the action.
- * @public - */ - Status?: ActionStatus | undefined; - - /** - *The new list of properties. Overwrites the current property list.
- * @public - */ - Properties?: RecordA list of properties to remove.
- * @public - */ - PropertiesToRemove?: string[] | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_5.ts b/clients/client-sagemaker/src/models/models_5.ts index 90b2ad9b2b08..5e150da26570 100644 --- a/clients/client-sagemaker/src/models/models_5.ts +++ b/clients/client-sagemaker/src/models/models_5.ts @@ -2,6 +2,7 @@ import { SENSITIVE_STRING } from "@smithy/smithy-client"; import { + ActionStatus, ActivationState, AdditionalInferenceSpecificationDefinition, AppNetworkAccessType, @@ -78,6 +79,7 @@ import { DomainSettingsForUpdate, Filter, GitConfigForUpdate, + InferenceComponentDeploymentConfig, ResourceType, Workforce, Workteam, @@ -93,6 +95,74 @@ import { VisibilityConditions, } from "./models_4"; +/** + * @public + */ +export interface StopProcessingJobRequest { + /** + *The name of the processing job to stop.
+ * @public + */ + ProcessingJobName: string | undefined; +} + +/** + * @public + */ +export interface StopTrainingJobRequest { + /** + *The name of the training job to stop.
+ * @public + */ + TrainingJobName: string | undefined; +} + +/** + * @public + */ +export interface StopTransformJobRequest { + /** + *The name of the batch transform job to stop.
+ * @public + */ + TransformJobName: string | undefined; +} + +/** + * @public + */ +export interface UpdateActionRequest { + /** + *The name of the action to update.
+ * @public + */ + ActionName: string | undefined; + + /** + *The new description for the action.
+ * @public + */ + Description?: string | undefined; + + /** + *The new status for the action.
+ * @public + */ + Status?: ActionStatus | undefined; + + /** + *The new list of properties. Overwrites the current property list.
+ * @public + */ + Properties?: RecordA list of properties to remove.
+ * @public + */ + PropertiesToRemove?: string[] | undefined; +} + /** * @public */ @@ -1103,6 +1173,13 @@ export interface UpdateInferenceComponentInput { * @public */ RuntimeConfig?: InferenceComponentRuntimeConfig | undefined; + + /** + *The deployment configuration for the inference component. The configuration contains the + * desired deployment strategy and rollback settings.
+ * @public + */ + DeploymentConfig?: InferenceComponentDeploymentConfig | undefined; } /** @@ -1359,8 +1436,8 @@ export interface UpdateModelPackageInput { AdditionalInferenceSpecificationsToAdd?: AdditionalInferenceSpecificationDefinition[] | undefined; /** - *Specifies details about inference jobs that you can run with models based on this model - * package, including the following information:
+ *Specifies details about inference jobs that you can run with models based on this + * model package, including the following information:
*The Amazon ECR paths of containers that contain the inference code and model @@ -1386,32 +1463,28 @@ export interface UpdateModelPackageInput { SourceUri?: string | undefined; /** - *
The model card associated with the model package. Since ModelPackageModelCard is
- * tied to a model package, it is a specific usage of a model card and its schema is
- * simplified compared to the schema of ModelCard. The
- * ModelPackageModelCard schema does not include model_package_details,
- * and model_overview is composed of the model_creator and
- * model_artifact properties. For more information about the model package model
- * card schema, see Model
- * package model card schema. For more information about
- * the model card associated with the model package, see View
- * the Details of a Model Version.
The model card associated with the model package. Since
+ * ModelPackageModelCard is tied to a model package, it is a specific
+ * usage of a model card and its schema is simplified compared to the schema of
+ * ModelCard. The ModelPackageModelCard schema does not
+ * include model_package_details, and model_overview is composed
+ * of the model_creator and model_artifact properties. For more
+ * information about the model package model card schema, see Model
+ * package model card schema. For more information about the model card
+ * associated with the model package, see View the Details of a Model
+ * Version.
- * A structure describing the current state of the model in its life cycle. - *
+ *A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; /** - *- * A unique token that guarantees that the call to this API is idempotent. - *
+ *A unique token that guarantees that the call to this API is idempotent.
* @public */ ClientToken?: string | undefined; diff --git a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts index 236854e61913..c99a88ea5c1c 100644 --- a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts +++ b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts @@ -1837,7 +1837,10 @@ import { ImageVersion, ImportHubContentRequest, ImportHubContentResponse, + InferenceComponentCapacitySize, InferenceComponentContainerSpecificationSummary, + InferenceComponentDeploymentConfig, + InferenceComponentRollingUpdatePolicy, InferenceComponentRuntimeConfigSummary, InferenceComponentSpecificationSummary, InferenceComponentSummary, @@ -1887,8 +1890,6 @@ import { ListContextsRequest, ListContextsResponse, ListDataQualityJobDefinitionsRequest, - ListDataQualityJobDefinitionsResponse, - ListDeviceFleetsRequest, MetricData, MetricSpecification, ModelCardExportArtifacts, @@ -1897,7 +1898,6 @@ import { ModelPackageStatusItem, ModelVariantConfigSummary, MonitoringExecutionSummary, - MonitoringJobDefinitionSummary, MonitoringSchedule, ObjectiveStatusCounters, OidcConfigForResponse, @@ -1934,6 +1934,8 @@ import { Workteam, } from "../models/models_3"; import { + ListDataQualityJobDefinitionsResponse, + ListDeviceFleetsRequest, ListDeviceFleetsResponse, ListDevicesRequest, ListDevicesResponse, @@ -2084,6 +2086,7 @@ import { MonitoringAlertActions, MonitoringAlertHistorySummary, MonitoringAlertSummary, + MonitoringJobDefinitionSummary, MonitoringScheduleSummary, NestedFilters, NotebookInstanceLifecycleConfigSummary, @@ -2161,9 +2164,6 @@ import { StopOptimizationJobRequest, StopPipelineExecutionRequest, StopPipelineExecutionResponse, - StopProcessingJobRequest, - StopTrainingJobRequest, - StopTransformJobRequest, StudioLifecycleConfigDetails, TrackingServerSummary, TrainingJob, @@ -2182,7 +2182,6 @@ import { TrialComponentSummary, TrialSummary, TuningJobStepMetaData, - UpdateActionRequest, UserProfileDetails, Vertex, VisibilityConditions, @@ -2191,7 +2190,11 @@ import { SearchExpression, SearchRequest, ServiceCatalogProvisioningUpdateDetails, + StopProcessingJobRequest, + StopTrainingJobRequest, + StopTransformJobRequest, ThroughputConfigUpdate, + UpdateActionRequest, UpdateActionResponse, UpdateAppImageConfigRequest, UpdateAppImageConfigResponse, @@ -15243,6 +15246,8 @@ const se_HyperParameterTuningJobConfig = (input: HyperParameterTuningJobConfig, // se_ImportHubContentRequest omitted. +// se_InferenceComponentCapacitySize omitted. + /** * serializeAws_json1_1InferenceComponentComputeResourceRequirements */ @@ -15260,6 +15265,10 @@ const se_InferenceComponentComputeResourceRequirements = ( // se_InferenceComponentContainerSpecification omitted. +// se_InferenceComponentDeploymentConfig omitted. + +// se_InferenceComponentRollingUpdatePolicy omitted. + // se_InferenceComponentRuntimeConfig omitted. /** @@ -17417,6 +17426,7 @@ const se_UpdateEndpointWeightsAndCapacitiesInput = ( */ const se_UpdateInferenceComponentInput = (input: UpdateInferenceComponentInput, context: __SerdeContext): any => { return take(input, { + DeploymentConfig: _json, InferenceComponentName: [], RuntimeConfig: _json, Specification: (_) => se_InferenceComponentSpecification(_, context), @@ -21707,6 +21717,7 @@ const de_DescribeInferenceComponentOutput = ( InferenceComponentArn: __expectString, InferenceComponentName: __expectString, InferenceComponentStatus: __expectString, + LastDeploymentConfig: (_: any) => de_InferenceComponentDeploymentConfig(_, context), LastModifiedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), RuntimeConfig: (_: any) => de_InferenceComponentRuntimeConfigSummary(_, context), Specification: (_: any) => de_InferenceComponentSpecificationSummary(_, context), @@ -24613,6 +24624,16 @@ const de_ImportHubContentResponse = (output: any, context: __SerdeContext): Impo }) as any; }; +/** + * deserializeAws_json1_1InferenceComponentCapacitySize + */ +const de_InferenceComponentCapacitySize = (output: any, context: __SerdeContext): InferenceComponentCapacitySize => { + return take(output, { + Type: __expectString, + Value: __expectInt32, + }) as any; +}; + /** * deserializeAws_json1_1InferenceComponentComputeResourceRequirements */ @@ -24642,6 +24663,34 @@ const de_InferenceComponentContainerSpecificationSummary = ( }) as any; }; +/** + * deserializeAws_json1_1InferenceComponentDeploymentConfig + */ +const de_InferenceComponentDeploymentConfig = ( + output: any, + context: __SerdeContext +): InferenceComponentDeploymentConfig => { + return take(output, { + AutoRollbackConfiguration: (_: any) => de_AutoRollbackConfig(_, context), + RollingUpdatePolicy: (_: any) => de_InferenceComponentRollingUpdatePolicy(_, context), + }) as any; +}; + +/** + * deserializeAws_json1_1InferenceComponentRollingUpdatePolicy + */ +const de_InferenceComponentRollingUpdatePolicy = ( + output: any, + context: __SerdeContext +): InferenceComponentRollingUpdatePolicy => { + return take(output, { + MaximumBatchSize: (_: any) => de_InferenceComponentCapacitySize(_, context), + MaximumExecutionTimeoutInSeconds: __expectInt32, + RollbackMaximumBatchSize: (_: any) => de_InferenceComponentCapacitySize(_, context), + WaitIntervalInSeconds: __expectInt32, + }) as any; +}; + /** * deserializeAws_json1_1InferenceComponentRuntimeConfigSummary */ diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 0e98c8632b02..5b1c82d211cb 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -4821,7 +4821,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 99 + "max": 3000 } } }, @@ -4840,7 +4840,7 @@ "target": "com.amazonaws.sagemaker#ClusterNodeIds", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of node IDs to be deleted from the specified cluster.
\nFor SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances\n that are configured as Slurm controller nodes.
\nA list of node IDs to be deleted from the specified cluster.
\nFor SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove\n instances that are configured as Slurm controller nodes.
\nIf you need to delete more than 99 instances, contact Support for assistance.
\nA map of the resource and BatchDescribeModelPackageError objects \n reporting the error associated with describing the model package.
" + "smithy.api#documentation": "A map of the resource and BatchDescribeModelPackageError objects reporting the error\n associated with describing the model package.
" } } }, @@ -6011,24 +6011,24 @@ "CheckJobArn": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the check processing job that was run by this step's\n execution.
" } }, "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if the drift check against the previous baseline will be skipped\n or not. If it is set to False, the previous baseline of the configured\n check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.
This flag indicates if a newly calculated baseline can be accessed through step\n properties BaselineUsedForDriftCheckConstraints and\n BaselineUsedForDriftCheckStatistics. If it is set to\n False, the previous baseline of the configured check type must also be\n available. These can be accessed through the\n BaselineUsedForDriftCheckConstraints property.
The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n
" + "smithy.api#documentation": "The container for the metadata for the ClarifyCheck step. For more information, see\n the topic on ClarifyCheck step in the Amazon SageMaker Developer\n Guide.
" } }, "com.amazonaws.sagemaker#ClarifyContentTemplate": { @@ -7876,7 +7876,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 99 + "max": 3000 } } }, @@ -13168,7 +13168,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
\nTo create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.
There are two types of model packages:
\nVersioned - a model that is part of a model group in the model\n registry.
\nUnversioned - a model package that is not part of a model group.
\nCreates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers\n can subscribe to model packages listed on Amazon Web Services Marketplace to create\n models in SageMaker.
\nTo create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.
There are two types of model packages:
\nVersioned - a model that is part of a model group in the model\n registry.
\nUnversioned - a model package that is not part of a model group.
\nA list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "A list of key value pairs associated with the model group. For more information, see\n Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" } } }, @@ -13244,7 +13244,7 @@ "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
\nThis parameter is required for versioned models, and does not apply to unversioned\n models.
" + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package group that this model version belongs\n to.
\nThis parameter is required for versioned models, and does not apply to unversioned\n models.
" } }, "ModelPackageDescription": { @@ -13256,7 +13256,7 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies details about inference jobs that you can run with models based on this\n model package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nWhether to certify the model package for listing on Amazon Web Services Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" + "smithy.api#documentation": "Whether to certify the model package for listing on Amazon Web Services\n Marketplace.
\nThis parameter is optional for unversioned models, and does not apply to versioned\n models.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
\nIf you supply ModelPackageGroupName, your model package belongs to the model group\n\t you specify and uses the tags associated with the model group. In this case, you cannot\n\t supply a tag argument.\n
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
\nIf you supply ModelPackageGroupName, your model package belongs to the\n model group you specify and uses the tags associated with the model group. In this case,\n you cannot supply a tag argument.
Whether the model is approved for deployment.
\nThis parameter is optional for versioned models, and does not apply to unversioned\n models.
\nFor versioned models, the value of this parameter must be set to Approved\n to deploy the model.
Whether the model is approved for deployment.
\nThis parameter is optional for versioned models, and does not apply to unversioned\n models.
\nFor versioned models, the value of this parameter must be set to Approved\n to deploy the model.
The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common machine\n learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification. The following\n tasks are supported by Inference Recommender:\n \"IMAGE_CLASSIFICATION\" | \"OBJECT_DETECTION\" | \"TEXT_GENERATION\" |\"IMAGE_SEGMENTATION\" |\n \"FILL_MASK\" | \"CLASSIFICATION\" | \"REGRESSION\" | \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning\n tasks include object detection and image classification. The following tasks are\n supported by Inference Recommender: \"IMAGE_CLASSIFICATION\" |\n \"OBJECT_DETECTION\" | \"TEXT_GENERATION\"\n |\"IMAGE_SEGMENTATION\" | \"FILL_MASK\" |\n \"CLASSIFICATION\" | \"REGRESSION\" |\n \"OTHER\".
Specify \"OTHER\" if none of the tasks listed fit your use case.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point\n to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files\n that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the\n InvokeEndpoint call.
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a\n single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple\n files that are all equally used in the load test. Each file in the archive must satisfy\n the size constraints of the InvokeEndpoint call.
" } }, "CustomerMetadataProperties": { @@ -13332,13 +13332,13 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker\n Pipelines in the Amazon SageMaker Developer Guide.
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the\n compiled artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference\n Specification specifies artifacts based on this model package that can be used on\n inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.\n
" } }, "SkipModelValidation": { @@ -13350,25 +13350,25 @@ "SourceUri": { "target": "com.amazonaws.sagemaker#ModelPackageSourceUri", "traits": { - "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.
" + "smithy.api#documentation": "The URI of the source for the model package. If you want to clone a model package, set\n it to the model package Amazon Resource Name (ARN). If you want to register a model, set\n it to the model ARN.
" } }, "SecurityConfig": { "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
\n A structure describing the current state of the model in its life cycle.\n
" + "smithy.api#documentation": "A structure describing the current state of the model in its life cycle.
" } } }, @@ -17876,7 +17876,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a model package.
\nA model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
" + "smithy.api#documentation": "Deletes a model package.
\nA model package is used to create SageMaker models or list on Amazon Web Services\n Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace to create models in SageMaker.
" } }, "com.amazonaws.sagemaker#DeleteModelPackageGroup": { @@ -17947,7 +17947,7 @@ "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to delete.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid characters are\n a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } } @@ -23171,6 +23171,12 @@ "traits": { "smithy.api#documentation": "The status of the inference component.
" } + }, + "LastDeploymentConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentDeploymentConfig", + "traits": { + "smithy.api#documentation": "The deployment and rollback settings that you assigned to the inference\n component.
" + } } }, "traits": { @@ -24433,7 +24439,7 @@ "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" }, "traits": { - "smithy.api#documentation": "Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.
\nIf you provided a KMS Key ID when you created your model package,\n you will see the KMS\n Decrypt API call in your CloudTrail logs when you use this API.
\nTo create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.
" + "smithy.api#documentation": "Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.
\nIf you provided a KMS Key ID when you created your model package,\n you will see the KMS Decrypt API call in\n your CloudTrail logs when you use this API.
\nTo create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#DescribeModelPackageGroup": { @@ -24524,7 +24530,7 @@ "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the model package to describe.
\nWhen you specify a name, the name must have 1 to 63 characters. Valid characters are\n a-z, A-Z, 0-9, and - (hyphen).
", "smithy.api#required": {} } } @@ -24615,7 +24621,7 @@ "CertifyForMarketplace": { "target": "com.amazonaws.sagemaker#CertifyForMarketplace", "traits": { - "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Whether the model package is certified for listing on Amazon Web Services\n Marketplace.
" } }, "ModelApprovalStatus": { @@ -24660,13 +24666,13 @@ "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes.\n Common machine learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task you specified that your model package accomplishes. Common\n machine learning tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single\n gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a\n single gzip compressed tar archive (.tar.gz suffix).
" } }, "CustomerMetadataProperties": { @@ -24678,13 +24684,13 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker\n Pipelines in the Amazon SageMaker Developer Guide.
" } }, "AdditionalInferenceSpecifications": { "target": "com.amazonaws.sagemaker#AdditionalInferenceSpecifications", "traits": { - "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional\n Inference Specification specifies artifacts based on this model package that can\n be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
" + "smithy.api#documentation": "An array of additional Inference Specification objects. Each additional Inference\n Specification specifies artifacts based on this model package that can be used on\n inference endpoints. Generally used with SageMaker Neo to store the compiled\n artifacts.
" } }, "SkipModelValidation": { @@ -24702,19 +24708,19 @@ "SecurityConfig": { "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", "traits": { - "smithy.api#documentation": "The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
\n A structure describing the current state of the model in its life cycle.\n
" + "smithy.api#documentation": "A structure describing the current state of the model in its life cycle.
" } } }, @@ -28544,30 +28550,30 @@ "Bias": { "target": "com.amazonaws.sagemaker#DriftCheckBias", "traits": { - "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.
" + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is\n set using the model package.
" } }, "Explainability": { "target": "com.amazonaws.sagemaker#DriftCheckExplainability", "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.
" + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model\n monitor is set using the model package.
" } }, "ModelQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model\n monitor is set using the model package.
" } }, "ModelDataQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", "traits": { - "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.
" + "smithy.api#documentation": "Represents the drift check model data quality baselines that can be used when the\n model monitor is set using the model package.
" } } }, "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model \n package.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckBias": { @@ -28593,7 +28599,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.
" + "smithy.api#documentation": "Represents the drift check bias baselines that can be used when the model monitor is\n set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckExplainability": { @@ -28613,7 +28619,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.
" + "smithy.api#documentation": "Represents the drift check explainability baselines that can be used when the model\n monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { @@ -28633,7 +28639,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.
" + "smithy.api#documentation": "Represents the drift check data quality baselines that can be used when the model\n monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DriftCheckModelQuality": { @@ -28653,7 +28659,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" + "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model\n monitor is set using the model package.
" } }, "com.amazonaws.sagemaker#DynamicScalingConfiguration": { @@ -30404,7 +30410,7 @@ } }, "traits": { - "smithy.api#documentation": "The properties of an experiment as returned by the Search API.
" + "smithy.api#documentation": "The properties of an experiment as returned by the Search API.\n For information about experiments, see the \n CreateExperiment API.
" } }, "com.amazonaws.sagemaker#ExperimentArn": { @@ -32088,7 +32094,7 @@ "target": "com.amazonaws.sagemaker#GetModelPackageGroupPolicyOutput" }, "traits": { - "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and\n Access Management User Guide..
" + "smithy.api#documentation": "Gets a resource policy that manages access for a model group. For information about\n resource policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services\n Identity and Access Management User Guide..
" } }, "com.amazonaws.sagemaker#GetModelPackageGroupPolicyInput": { @@ -35185,6 +35191,47 @@ } } }, + "com.amazonaws.sagemaker#InferenceComponentCapacitySize": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.sagemaker#InferenceComponentCapacitySizeType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the endpoint capacity type.
\nThe endpoint activates based on the number of inference component\n copies.
\nThe endpoint activates based on the specified percentage of capacity.
\nDefines the capacity size, either as a number of inference component copies or a\n capacity percentage.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a rolling\n deployment or a rollback strategy. You can specify your batches as either of the\n following:
\nA count of inference component copies
\nThe overall percentage or your fleet
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value parameter to 100%, then SageMaker AI uses a blue/green rollback\n strategy and rolls all traffic back to the blue fleet.
Specifies a rolling deployment strategy for updating a SageMaker AI\n endpoint.
", + "smithy.api#required": {} + } + }, + "AutoRollbackConfiguration": { + "target": "com.amazonaws.sagemaker#AutoRollbackConfig" + } + }, + "traits": { + "smithy.api#documentation": "The deployment configuration for an endpoint that hosts inference components. The\n configuration includes the desired deployment strategy and rollback settings.
" + } + }, "com.amazonaws.sagemaker#InferenceComponentName": { "type": "string", "traits": { @@ -35296,6 +35362,42 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, + "com.amazonaws.sagemaker#InferenceComponentRollingUpdatePolicy": { + "type": "structure", + "members": { + "MaximumBatchSize": { + "target": "com.amazonaws.sagemaker#InferenceComponentCapacitySize", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The batch size for each rolling step in the deployment process. For each step, SageMaker AI provisions capacity on the new endpoint fleet, routes traffic to that fleet,\n and terminates capacity on the old endpoint fleet. The value must be between 5% to 50% of\n the copy count of the inference component.
", + "smithy.api#required": {} + } + }, + "WaitIntervalInSeconds": { + "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The length of the baking period, during which SageMaker AI monitors alarms for each\n batch on the new fleet.
", + "smithy.api#required": {} + } + }, + "MaximumExecutionTimeoutInSeconds": { + "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The time limit for the total deployment. Exceeding this limit causes a timeout.
" + } + }, + "RollbackMaximumBatchSize": { + "target": "com.amazonaws.sagemaker#InferenceComponentCapacitySize", + "traits": { + "smithy.api#documentation": "The batch size for a rollback to the old endpoint fleet. If this field is absent, the\n value is set to the default, which is 100% of the total capacity. When the default is used,\n SageMaker AI provisions the entire capacity of the old fleet at once during\n rollback.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a rolling deployment strategy for updating a SageMaker AI inference\n component.
" + } + }, "com.amazonaws.sagemaker#InferenceComponentRuntimeConfig": { "type": "structure", "members": { @@ -43572,7 +43674,7 @@ "CrossAccountFilterOption": { "target": "com.amazonaws.sagemaker#CrossAccountFilterOption", "traits": { - "smithy.api#documentation": "A filter that returns either model groups shared with you or model groups in\n\t your own account. When the value is CrossAccount, the results show\n\t the resources made discoverable to you from other accounts. When the value is\n SameAccount or null, the results show resources from your\n \t account. The default is SameAccount.
A filter that returns either model groups shared with you or model groups in your own\n account. When the value is CrossAccount, the results show the resources\n made discoverable to you from other accounts. When the value is SameAccount\n or null, the results show resources from your account. The default is\n SameAccount.
If the response is truncated, SageMaker returns this token. To retrieve the next set\n of model groups, use it in the subsequent request.
" + "smithy.api#documentation": "If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model groups, use it in the subsequent request.
" } } }, @@ -43656,13 +43758,13 @@ "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model group.
" + "smithy.api#documentation": "A filter that returns only model versions that belong to the specified model\n group.
" } }, "ModelPackageType": { "target": "com.amazonaws.sagemaker#ModelPackageType", "traits": { - "smithy.api#documentation": "A filter that returns only the model packages of the specified type. This can be one\n of the following values.
\n\n UNVERSIONED - List only unversioined models. \n This is the default value if no ModelPackageType is specified.
\n VERSIONED - List only versioned models.
\n BOTH - List both versioned and unversioned models.
A filter that returns only the model packages of the specified type. This can be one\n of the following values.
\n\n UNVERSIONED - List only unversioined models. This is the default\n value if no ModelPackageType is specified.
\n VERSIONED - List only versioned models.
\n BOTH - List both versioned and unversioned models.
\n The current stage in the model life cycle.\n
", + "smithy.api#documentation": "The current stage in the model life cycle.
", "smithy.api#required": {} } }, @@ -48681,19 +48783,19 @@ "target": "com.amazonaws.sagemaker#EntityName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n The current status of a stage in model life cycle.\n
", + "smithy.api#documentation": "The current status of a stage in model life cycle.
", "smithy.api#required": {} } }, "StageDescription": { "target": "com.amazonaws.sagemaker#StageDescription", "traits": { - "smithy.api#documentation": "\n Describes the stage related details.\n
" + "smithy.api#documentation": "Describes the stage related details.
" } } }, "traits": { - "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + "smithy.api#documentation": "A structure describing the current state of the model in its life cycle.
" } }, "com.amazonaws.sagemaker#ModelMetadataFilter": { @@ -48887,7 +48989,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#EntityName", "traits": { - "smithy.api#documentation": "The name of the model.
" + "smithy.api#documentation": "The name of the model package. The name can be as follows:
\nFor a versioned model, the name is automatically generated by SageMaker Model Registry and\n follows the format\n 'ModelPackageGroupName/ModelPackageVersion'.
For an unversioned model, you must provide the name.
\nSpecifies batch transform jobs that SageMaker runs to validate your model package.
" + "smithy.api#documentation": "Specifies batch transform jobs that SageMaker runs to validate your model\n package.
" } }, "ModelPackageStatus": { "target": "com.amazonaws.sagemaker#ModelPackageStatus", "traits": { - "smithy.api#documentation": "The status of the model package. This can be one of the following values.
\n\n PENDING - The model package is pending being created.
\n IN_PROGRESS - The model package is in the process of being\n created.
\n COMPLETED - The model package was successfully created.
\n FAILED - The model package failed.
\n DELETING - The model package is in the process of being deleted.
The status of the model package. This can be one of the following values.
\n\n PENDING - The model package is pending being created.
\n IN_PROGRESS - The model package is in the process of being\n created.
\n COMPLETED - The model package was successfully created.
\n FAILED - The model package failed.
\n DELETING - The model package is in the process of being\n deleted.
Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For\n information about listing model packages on Amazon Web Services Marketplace, see List Your\n Algorithm or Model Package on Amazon Web Services Marketplace.
" + "smithy.api#documentation": "Whether the model package is to be certified to be listed on Amazon Web Services\n Marketplace. For information about listing model packages on Amazon Web Services\n Marketplace, see List Your Algorithm or Model\n Package on Amazon Web Services Marketplace.
" } }, "ModelApprovalStatus": { @@ -48965,7 +49067,7 @@ "CreatedBy": { "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, or project.
" } }, "MetadataProperties": { @@ -48989,7 +49091,7 @@ "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext", "traits": { - "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
" + "smithy.api#documentation": "Information about the user who created or modified an experiment, trial, trial\n component, lineage group, or project.
" } }, "ApprovalDescription": { @@ -49001,19 +49103,19 @@ "Domain": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning domain of your model package and its components. Common\n machine learning domains include computer vision and natural language processing.
" + "smithy.api#documentation": "The machine learning domain of your model package and its components. Common machine\n learning domains include computer vision and natural language processing.
" } }, "Task": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine\n learning tasks include object detection and image classification.
" + "smithy.api#documentation": "The machine learning task your model package accomplishes. Common machine learning\n tasks include object detection and image classification.
" } }, "SamplePayloadUrl": { "target": "com.amazonaws.sagemaker#String", "traits": { - "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to\n a single gzip compressed tar archive (.tar.gz suffix).
" + "smithy.api#documentation": "The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a\n single gzip compressed tar archive (.tar.gz suffix).
" } }, "AdditionalInferenceSpecifications": { @@ -49037,13 +49139,13 @@ "ModelLifeCycle": { "target": "com.amazonaws.sagemaker#ModelLifeCycle", "traits": { - "smithy.api#documentation": "\n A structure describing the current state of the model in its life cycle.\n
" + "smithy.api#documentation": "A structure describing the current state of the model in its life cycle.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" } }, "CustomerMetadataProperties": { @@ -49055,7 +49157,7 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set using the model package.
" + "smithy.api#documentation": "Represents the drift check baselines that can be used when the model monitor is set\n using the model package.
" } }, "SkipModelValidation": { @@ -49066,7 +49168,7 @@ } }, "traits": { - "smithy.api#documentation": "A versioned model that can be deployed for SageMaker inference.
" + "smithy.api#documentation": "A container for your trained model that can be deployed for SageMaker inference. This can\n include inference code, artifacts, and metadata. The model package type can be one of\n the following.
\nVersioned model: A part of a model package group in Model Registry.
\nUnversioned model: Not part of a model package group and used in Amazon Web Services Marketplace.
\nFor more information, see \n CreateModelPackage\n .
The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.
\nIf you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.
The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nThe Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same region as the\n model package.
\nThe environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
The environment variables to set in the Docker container. Each key and value in the\n Environment string to string map can have length of up to 1024. We\n support up to 16 entries in the map.
The status of the model group. This can be one of the following values.
\n\n PENDING - The model group is pending being created.
\n IN_PROGRESS - The model group is in the process of being\n created.
\n COMPLETED - The model group was successfully created.
\n FAILED - The model group failed.
\n DELETING - The model group is in the process of being deleted.
\n DELETE_FAILED - SageMaker failed to delete the model group.
The status of the model group. This can be one of the following values.
\n\n PENDING - The model group is pending being created.
\n IN_PROGRESS - The model group is in the process of being\n created.
\n COMPLETED - The model group was successfully created.
\n FAILED - The model group failed.
\n DELETING - The model group is in the process of being\n deleted.
\n DELETE_FAILED - SageMaker failed to delete the model group.
A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" } } }, "traits": { - "smithy.api#documentation": "A group of versioned models in the model registry.
" + "smithy.api#documentation": "A group of versioned models in the Model Registry.
" } }, "com.amazonaws.sagemaker#ModelPackageGroupArn": { @@ -49374,18 +49476,18 @@ "ModelCardContent": { "target": "com.amazonaws.sagemaker#ModelCardContent", "traits": { - "smithy.api#documentation": "The content of the model card. The content must follow the schema described\n in Model\n Package Model Card Schema.
" + "smithy.api#documentation": "The content of the model card. The content must follow the schema described in Model\n Package Model Card Schema.
" } }, "ModelCardStatus": { "target": "com.amazonaws.sagemaker#ModelCardStatus", "traits": { - "smithy.api#documentation": "The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates can be made to the model\n card content. If you try to update the model card content, you will receive the message Model Card\n \t is in Archived state.
The approval status of the model card within your organization. Different\n organizations might have different criteria for model card review and approval.
\n\n Draft: The model card is a work in progress.
\n PendingReview: The model card is pending review.
\n Approved: The model card is approved.
\n Archived: The model card is archived. No more updates can be made\n to the model card content. If you try to update the model card content, you will\n receive the message Model Card is in Archived state.
The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
The KMS Key ID (KMSKeyId) used for encryption of model package information.
The KMS Key ID (KMSKeyId) used for encryption of model\n package information.
An optional Key Management Service\n key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with\n highly sensitive data.
" + "smithy.api#documentation": "An optional Key Management Service key to encrypt, decrypt, and re-encrypt model\n package information for regulated workloads with highly sensitive data.
" } }, "com.amazonaws.sagemaker#ModelPackageSortBy": { @@ -49645,7 +49747,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.
\nThe data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.
" + "smithy.api#documentation": "Contains data, such as the inputs and targeted instance types that are used in the\n process of validating the model package.
\nThe data provided in the validation profile is made available to your buyers on\n Amazon Web Services Marketplace.
" } }, "com.amazonaws.sagemaker#ModelPackageValidationProfiles": { @@ -51049,12 +51151,12 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference Guide.
" + "smithy.api#documentation": "A list of the tags associated with the monitoring schedlue. For more information, see\n Tagging Amazon Web Services resources in the Amazon Web Services General\n Reference Guide.
" } } }, "traits": { - "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see\n Amazon SageMaker Model\n Monitor.
" + "smithy.api#documentation": "A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model\n Monitor.
" } }, "com.amazonaws.sagemaker#MonitoringScheduleArn": { @@ -58030,7 +58132,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
" + "smithy.api#documentation": "Adds a resouce policy to control access to a model group. For information about\n resoure policies, see Identity-based\n policies and resource-based policies in the Amazon Web Services\n Identity and Access Management User Guide..
" } }, "com.amazonaws.sagemaker#PutModelPackageGroupPolicyInput": { @@ -68044,7 +68146,7 @@ "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Traffic routing strategy type.
\n\n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet\n in a single step.\n
\n CANARY: Endpoint traffic shifts to the new fleet\n in two steps. The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.\n
\n LINEAR: Endpoint traffic shifts to the new fleet in\n n steps of a configurable size.\n
Traffic routing strategy type.
\n\n ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single\n step.
\n CANARY: Endpoint traffic shifts to the new fleet in two steps.\n The first step is the canary, which is a small portion of the traffic. The\n second step is the remainder of the traffic.
\n LINEAR: Endpoint traffic shifts to the new fleet in n steps of a\n configurable size.
The waiting time (in seconds) between incremental steps to turn on traffic on the\n new endpoint fleet.
", + "smithy.api#documentation": "The waiting time (in seconds) between incremental steps to turn on traffic on the new\n endpoint fleet.
", "smithy.api#required": {} } }, "CanarySize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.
Batch size for the first step to turn on traffic on the new endpoint fleet.\n Value must be less than or equal to 50% of the variant's total instance\n count.
Batch size for each step to turn on traffic on the new endpoint fleet. Value must be\n 10-50% of the variant's total instance count.
Batch size for each step to turn on traffic on the new endpoint fleet.\n Value must be 10-50% of the variant's total instance count.
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the\n old fleet to the new fleet.
" + "smithy.api#documentation": "Defines the traffic routing strategy during an endpoint deployment to shift traffic\n from the old fleet to the new fleet.
" } }, "com.amazonaws.sagemaker#TrafficRoutingConfigType": { @@ -73398,6 +73500,12 @@ "traits": { "smithy.api#documentation": "Runtime settings for a model that is deployed with an inference component.
" } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#InferenceComponentDeploymentConfig", + "traits": { + "smithy.api#documentation": "The deployment configuration for the inference component. The configuration contains the\n desired deployment strategy and rollback settings.
" + } } }, "traits": { @@ -73764,7 +73872,7 @@ "InferenceSpecification": { "target": "com.amazonaws.sagemaker#InferenceSpecification", "traits": { - "smithy.api#documentation": "Specifies details about inference jobs that you can run with models based on this model\n package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nSpecifies details about inference jobs that you can run with models based on this\n model package, including the following information:
\nThe Amazon ECR paths of containers that contain the inference code and model\n artifacts.
\nThe instance types that the model package supports for transform jobs and\n real-time endpoints used for inference.
\nThe input and output content formats that the model package supports for\n inference.
\nThe model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.
The model card associated with the model package. Since\n ModelPackageModelCard is tied to a model package, it is a specific\n usage of a model card and its schema is simplified compared to the schema of\n ModelCard. The ModelPackageModelCard schema does not\n include model_package_details, and model_overview is composed\n of the model_creator and model_artifact properties. For more\n information about the model package model card schema, see Model\n package model card schema. For more information about the model card\n associated with the model package, see View the Details of a Model\n Version.
\n A structure describing the current state of the model in its life cycle.\n
" + "smithy.api#documentation": "A structure describing the current state of the model in its life cycle.
" } }, "ClientToken": { "target": "com.amazonaws.sagemaker#ClientToken", "traits": { - "smithy.api#documentation": "\n A unique token that guarantees that the call to this API is idempotent.\n
" + "smithy.api#documentation": "A unique token that guarantees that the call to this API is idempotent.
" } } },